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.
data
array
Optional. Data for populating the Message object.
↳ 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}
.
↳ 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
↳ 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}
.
string
setName
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
var
string
$this
getDatabase
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string
setDatabase
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
var
string
$this
getDatabaseUid
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string
setDatabaseUid
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
var
string
$this
getSnapshotTime
Output only. The backup contains an externally consistent copy of the database at this time.
hasSnapshotTime
clearSnapshotTime
setSnapshotTime
Output only. The backup contains an externally consistent copy of the database at this time.
$this
getExpireTime
Output only. The timestamp at which this backup expires.
hasExpireTime
clearExpireTime
setExpireTime
Output only. The timestamp at which this backup expires.
$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.
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.
$this
getState
Output only. The current state of the backup.
int
setState
Output only. The current state of the backup.
var
int
$this
