list method
Lists backups in a service.
Request parameters:
parent
- Required. The relative resource name of the service whose
backups to list, in the following
form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/services/\[^/\]+$
.
filter
- Optional. The filter to apply to list results.
orderBy
- Optional. Specify the ordering of results as described in
Sorting Order
(https://cloud.google.com/apis/design/design_patterns#sorting_order). If
not specified, the results will be sorted in the default order.
pageSize
- Optional. The maximum number of backups to return. The
response may contain less than the maximum number. If unspecified, no more
than 500 backups are returned. The maximum value is 1000; values above
1000 are changed to 1000.
pageToken
- Optional. A page token, received from a previous
DataprocMetastore.ListBackups call. Provide this token to retrieve the
subsequent page.To retrieve the first page, supply an empty page
token.When paginating, other parameters provided to
DataprocMetastore.ListBackups must match the call that provided the page
token.
$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.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
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>);
}