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 isprojects/{project}/locations/{location}/backups/{backup}.
Returns
Type
Description
string
setName
Output only. The unique resource name of the Backup.
Format isprojects/{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 isprojects/{project}/databases/{database}.
Returns
Type
Description
string
setDatabase
Output only. Name of the Firestore database that the backup is from.
Format isprojects/{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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class Backup (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.Backup)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.Backup)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.Backup)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.Backup)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.Backup)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.Backup)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.Backup)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.Backup)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.Backup)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.Backup)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.Backup)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.Backup)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.Backup)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.Backup)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.Backup)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.Backup)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.Backup)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.Backup)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.Backup)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.Backup)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.Backup)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.Backup)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.Backup) \nReference documentation and code samples for the Cloud Firestore V1 Client class Backup.\n\nA Backup of a Cloud Firestore Database.\n\nThe backup contains all documents and index configurations for the given\ndatabase at a specific point in time.\n\nGenerated from protobuf message `google.firestore.admin.v1.Backup`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The unique resource name of the Backup.\n\nFormat is `projects/{project}/locations/{location}/backups/{backup}`.\n\n### setName\n\nOutput only. The unique resource name of the Backup.\n\nFormat is `projects/{project}/locations/{location}/backups/{backup}`.\n\n### getDatabase\n\nOutput only. Name of the Firestore database that the backup is from.\n\nFormat is `projects/{project}/databases/{database}`.\n\n### setDatabase\n\nOutput only. Name of the Firestore database that the backup is from.\n\nFormat is `projects/{project}/databases/{database}`.\n\n### getDatabaseUid\n\nOutput only. The system-generated UUID4 for the Firestore database that the\nbackup is from.\n\n### setDatabaseUid\n\nOutput only. The system-generated UUID4 for the Firestore database that the\nbackup is from.\n\n### getSnapshotTime\n\nOutput only. The backup contains an externally consistent copy of the\ndatabase at this time.\n\n### hasSnapshotTime\n\n### clearSnapshotTime\n\n### setSnapshotTime\n\nOutput only. The backup contains an externally consistent copy of the\ndatabase at this time.\n\n### getExpireTime\n\nOutput only. The timestamp at which this backup expires.\n\n### hasExpireTime\n\n### clearExpireTime\n\n### setExpireTime\n\nOutput only. The timestamp at which this backup expires.\n\n### getStats\n\nOutput only. Statistics about the backup.\n\nThis data only becomes available after the backup is fully materialized to\nsecondary storage. This field will be empty till then.\n\n### hasStats\n\n### clearStats\n\n### setStats\n\nOutput only. Statistics about the backup.\n\nThis data only becomes available after the backup is fully materialized to\nsecondary storage. This field will be empty till then.\n\n### getState\n\nOutput only. The current state of the backup.\n\n### setState\n\nOutput only. The current state of the backup."]]
