list method

Future<ListInstancePartitionsResponse> list(String parent, { String? instancePartitionDeadline, int? pageSize, String? pageToken, String? $fields, })

Lists all instance partitions for the given instance.

Request parameters:

parent - Required. The instance whose instance partitions should be listed. Values are of the form projects//instances/. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+$.

instancePartitionDeadline - Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

pageSize - Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken - If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

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

Completes with a ListInstancePartitionsResponse.

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

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

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