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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The location to list backups from. Format is |
↳ 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: |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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)
| Returns | |
|---|---|
| Type | Description |
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)
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The location to list backups from. Format is |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|