list method

Future<GoogleFirestoreAdminV1ListBackupsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? $fields,
})

Lists all the backups.

Request parameters:

parent - Required. The location to list backups from. Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering:

  • database_uid (supports = only)

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

Completes with a GoogleFirestoreAdminV1ListBackupsResponse.

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

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

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