list method
Lists all backups owned by a backup collection.
Request parameters:
parent
- Required. The resource name of the backupCollection using the
form:
projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/backupCollections/\[^/\]+$
.
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 ListBackupsResponse.
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<ListBackupsResponse> 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') + '/backups';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListBackupsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}