Reference documentation and code samples for the Cloud Firestore V1 Client class ListBackupsRequest.
The request for FirestoreAdmin.ListBackups .
Generated from protobuf message google.firestore.admin.v1.ListBackupsRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
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.
↳ filter
string
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)
getParent
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.
string
setParent
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.
var
string
$this
getFilter
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)
string
setFilter
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)
var
string
$this
static::build
parent
string
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. Please see FirestoreAdminClient::locationName()
for help formatting this field.
