Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#database
defdatabase()->::String
Returns
(::String) — Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
#database=
defdatabase=(value)->::String
Parameter
value (::String) — Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
Returns
(::String) — Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
#database_uid
defdatabase_uid()->::String
Returns
(::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-09-04 UTC."],[],[],null,["# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::PitrSnapshot (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-PitrSnapshot)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-PitrSnapshot) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::PitrSnapshot.\n\nA consistent snapshot of a database at a specific point in time.\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\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #database\n\n def database() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the database that this was a snapshot of. Format: `projects/{project}/databases/{database}`.\n\n### #database=\n\n def database=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the database that this was a snapshot of. Format: `projects/{project}/databases/{database}`. \n**Returns**\n\n- (::String) --- Required. The name of the database that this was a snapshot of. Format: `projects/{project}/databases/{database}`.\n\n### #database_uid\n\n def database_uid() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Public UUID of the database the snapshot was associated with.\n\n### #snapshot_time\n\n def snapshot_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Required. Snapshot time of the database.\n\n### #snapshot_time=\n\n def snapshot_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Required. Snapshot time of the database. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Required. Snapshot time of the database."]]
