list method

Future<ListCapacityAllocationsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists CapacityAllocation resources in a given project and location.

Request parameters:

parent - Required. The resource name of the location to query for capacity allocations. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string or a number. The comparison operator must be =, !=, >, >=, <, or <=. The has operator : is also supported. Supported fields include name, display_name (or placement_group), machine_family, allocated_capacity_count, consumed_capacity_count, and connected_placement_group (using =). For example, if you are filtering a list of capacity allocations, you can exclude the ones named example-capacity-allocation by specifying name != "example-capacity-allocation". You can also filter on other fields, such as machine family ("ve1", "ve2", or "ve3") or connected placement group: machine_family = "ve1" connected_placement_group = "example-placement-group" To filter on multiple expressions, provide each separate expression within parentheses. For example: (machine_family = "ve1") (allocated_capacity_count > 10) By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. For example: ``` ((machine_family = "ve1") AND (allocated_capacity_count > 10)) OR (consumed_capacity_count

orderBy - Optional. Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

pageSize - Optional. The maximum number of capacity allocations to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

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

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

Completes with a ListCapacityAllocationsResponse.

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<ListCapacityAllocationsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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