list method

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

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Request parameters:

parent - Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

pageSize - Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

pageToken - Optional. The next_page_token value returned from a previous [ListBackupCollections] request, if any.

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

Completes with a ListBackupCollectionsResponse.

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<ListBackupCollectionsResponse> 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/' + core.Uri.encodeFull('$parent') + '/backupCollections';

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