Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database
def database() -> ::String
Returns
-
(::String) — Output only. Name of the Firestore database that the backup is from.
Format is
projects/{project}/databases/{database}.
#database_uid
def database_uid() -> ::String
Returns
- (::String) — Output only. The system-generated UUID4 for the Firestore database that the backup is from.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp at which this backup expires.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The unique resource name of the Backup.
Format is
projects/{project}/locations/{location}/backups/{backup}.
#snapshot_time
def snapshot_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The backup contains an externally consistent copy of the database at this time.
#state
def state() -> ::Google::Cloud::Firestore::Admin::V1::Backup::State
Returns
- (::Google::Cloud::Firestore::Admin::V1::Backup::State) — Output only. The current state of the backup.
#stats
def stats() -> ::Google::Cloud::Firestore::Admin::V1::Backup::Stats
Returns
-
(::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.