Reference documentation and code samples for the Cloud Firestore V1 Client class Backup.
A Backup of a Cloud Firestore Database.
The backup contains all documents and index configurations for the given database at a specific point in time.
Generated from protobuf message google.firestore.admin.v1.Backup
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The unique resource name of the Backup. Format is |
↳ database |
string
Output only. Name of the Firestore database that the backup is from. Format is |
↳ database_uid |
string
Output only. The system-generated UUID4 for the Firestore database that the backup is from. |
↳ snapshot_time |
Google\Protobuf\Timestamp
Output only. The backup contains an externally consistent copy of the database at this time. |
↳ expire_time |
Google\Protobuf\Timestamp
Output only. The timestamp at which this backup expires. |
↳ stats |
Google\Cloud\Firestore\Admin\V1\Backup\Stats
Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then. |
↳ state |
int
Output only. The current state of the backup. |
getName
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabase
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseUid
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseUid
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSnapshotTime
Output only. The backup contains an externally consistent copy of the database at this time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasSnapshotTime
clearSnapshotTime
setSnapshotTime
Output only. The backup contains an externally consistent copy of the database at this time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpireTime
Output only. The timestamp at which this backup expires.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpireTime
clearExpireTime
setExpireTime
Output only. The timestamp at which this backup expires.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStats
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Backup\Stats|null |
|
hasStats
clearStats
setStats
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Backup\Stats
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the backup.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The current state of the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|