REST Resource: projects.locations.backups

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,
  "stats": {
    object (Stats)
  },
  "state": enum (State)
}
Fields
name

string

Output only. The unique resource name of the Backup.

Format is projects/{project}/locations/{location}/backups/{backup}.
database

string

Output only. Name of the Firestore database that the backup is from.

Format is projects/{project}/databases/{database}.
databaseUid

string

Output only. The system-generated UUID4 for the Firestore database that the backup is from.
snapshotTime

string (Timestamp format)

Output only. The backup contains an externally consistent copy of the database at this time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Output only. The timestamp at which this backup expires.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
stats

object (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

enum (State)

Output only. The current state of the backup.

Stats

Backup specific statistics.

JSON representation 
{
  "sizeBytes": string,
  "documentCount": string,
  "indexCount": string
}
Fields
sizeBytes

string (int64 format)

Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.
documentCount

string (int64 format)

Output only. The total number of documents contained in the backup.
indexCount

string (int64 format)

Output only. The total number of index entries contained in 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

delete

 Deletes a backup.

get

 Gets information about a backup.

list

 Lists all the backups.