list method

Future<GoogleCloudApihubV1ListDeploymentsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

List deployment resources in the API hub.

Request parameters:

parent - Required. The parent, which owns this collection of deployment resources. Format: projects/{project}/locations/{location} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, > or =. Filters are not case sensitive. The following fields in the Deployments are eligible for filtering: * display_name - The display name of the Deployment. Allowed comparison operators: =. * create_time - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <. * resource_uri - A URI to the deployment resource. Allowed comparison operators: =. * api_versions - The API versions linked to this deployment. Allowed comparison operators: :. * source_project - The project/organization at source for the deployment. Allowed comparison operators: =. * source_environment - The environment at source for the deployment. Allowed comparison operators: =. * deployment_type.enum_values.values.id - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: :. * deployment_type.enum_values.values.display_name - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: :. * slo.string_values.values -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: :. * environment.enum_values.values.id - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: :. * environment.enum_values.values.display_name - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: :. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is :. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. A filter function is also supported in the filter string. The filter function is id(name). The id(name) function returns the id of the resource name. For example, id(name) = \"deployment-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/deployments/deployment-1\" provided the parent is projects/test-project-id/locations/test-location-id. Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. Here are a few examples: * environment.enum_values.values.id: staging-id - The allowed value id of the environment attribute associated with the Deployment is staging-id. * environment.enum_values.values.display_name: \"Staging Deployment\" - The allowed value display name of the environment attribute associated with the Deployment is Staging Deployment. * environment.enum_values.values.id: production-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The allowed value id of the environment attribute associated with the Deployment is production-id and Deployment was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC. * environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\" - The allowed value id of the environment attribute Deployment is production-id or string value of the slo attribute is 99.99%. * environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is staging-id and the value of the user defined attribute of type string is test.

pageSize - Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - Optional. A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListDeployments must match the call that provided the page token.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudApihubV1ListDeploymentsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudApihubV1ListDeploymentsResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/deployments';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudApihubV1ListDeploymentsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}