list method

Future<ListBackupsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? view, String? $fields, })

Lists Backups in a given project and location.

Request parameters:

parent - Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources for all locations, use "-" for the '{location}' value. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/backupVaults/\[^/\]+/dataSources/\[^/\]+$.

filter - Optional. Filtering results.

orderBy - Optional. Hint for how to order the results.

pageSize - Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken - Optional. A token identifying a page of results the server should return.

view - Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource. Possible string values are:

• "BACKUP_VIEW_UNSPECIFIED" : If the value is not set, the default 'FULL' view is used.
• "BACKUP_VIEW_BASIC" : Includes basic data about the Backup, but not the full contents.
• "BACKUP_VIEW_FULL" : Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).

$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? view,
  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 (view != null) 'view': [view],
    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>);
}