list method

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

Returns all committed cursor information for a subscription.

Request parameters:

parent - Required. The subscription for which to retrieve cursors. Structured like projects/{project_number}/locations/{location}/subscriptions/{subscription_id}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/subscriptions/\[^/\]+$.

pageSize - The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.

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

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

Completes with a ListPartitionCursorsResponse.

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

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

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