Reference documentation and code samples for the Cloud Firestore V1 Client class PitrSnapshot.
A consistent snapshot of a database at a specific point in time.
A PITR (Point-in-time recovery) snapshot with previous versions of a
database's data is available for every minute up to the associated database's
data retention period. If the PITR feature is enabled, the retention period
is 7 days; otherwise, it is one hour.
Generated from protobuf message google.firestore.admin.v1.PitrSnapshot
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ database
string
Required. The name of the database that this was a snapshot of. Format: projects/{project}/databases/{database}.
↳ database_uid
string
Output only. Public UUID of the database the snapshot was associated with.
[[["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-08-07 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class PitrSnapshot (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.PitrSnapshot)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.PitrSnapshot)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.PitrSnapshot)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.PitrSnapshot)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.PitrSnapshot)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.PitrSnapshot)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.PitrSnapshot)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.PitrSnapshot)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.PitrSnapshot)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.PitrSnapshot)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.PitrSnapshot)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.PitrSnapshot)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.PitrSnapshot)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.PitrSnapshot)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.PitrSnapshot)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.PitrSnapshot)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.PitrSnapshot)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.PitrSnapshot)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.PitrSnapshot)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.PitrSnapshot)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.PitrSnapshot)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.PitrSnapshot)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.PitrSnapshot) \nReference documentation and code samples for the Cloud Firestore V1 Client class PitrSnapshot.\n\nA consistent snapshot of a database at a specific point in time.\n\nA PITR (Point-in-time recovery) snapshot with previous versions of a\ndatabase's data is available for every minute up to the associated database's\ndata retention period. If the PITR feature is enabled, the retention period\nis 7 days; otherwise, it is one hour.\n\nGenerated from protobuf message `google.firestore.admin.v1.PitrSnapshot`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDatabase\n\nRequired. The name of the database that this was a snapshot of. Format:\n`projects/{project}/databases/{database}`.\n\n### setDatabase\n\nRequired. The name of the database that this was a snapshot of. Format:\n`projects/{project}/databases/{database}`.\n\n### getDatabaseUid\n\nOutput only. Public UUID of the database the snapshot was associated with.\n\n### setDatabaseUid\n\nOutput only. Public UUID of the database the snapshot was associated with.\n\n### getSnapshotTime\n\nRequired. Snapshot time of the database.\n\n### hasSnapshotTime\n\n### clearSnapshotTime\n\n### setSnapshotTime\n\nRequired. Snapshot time of the database."]]
