Resource: 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.
| JSON representation |
|---|
{
"name"
:
string
,
"database"
:
string
,
"databaseUid"
:
string
,
"snapshotTime"
:
string
,
"expireTime"
:
string
,
"state"
:
enum (
|
| Fields | |
|---|---|
name
|
Output only. The unique resource name of the Backup. Format is |
database
|
Output only. Name of the Firestore database that the backup is from. Format is |
databaseUid
|
Output only. The system-generated UUID4 for the Firestore database that the backup is from. |
snapshotTime
|
Output only. The backup contains an externally consistent copy of the database at this time. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
expireTime
|
Output only. The timestamp at which this backup expires. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
state
|
Output only. The current state of the backup. |
State
Indicate the current state of the backup.
| Enums | |
|---|---|
STATE_UNSPECIFIED
|
The state is unspecified. |
CREATING
|
The pending backup is still being created. Operations on the backup will be rejected in this state. |
READY
|
The backup is complete and ready to use. |
NOT_AVAILABLE
|
The backup is not available at this moment. |
Methods |
|
|---|---|
|
Deletes a backup. |
|
Gets information about a backup. |
|
Lists all the backups. |
