Cloud Firestore V1 Client - Class PitrSnapshot (1.53.1)

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.

↳ snapshot_time
Google\Protobuf\Timestamp

Required. Snapshot time of the database.

getDatabase

Required. The name of the database that this was a snapshot of. Format: projects/{project}/databases/{database} .

Returns
Type
Description
string

setDatabase

Required. The name of the database that this was a snapshot of. Format: projects/{project}/databases/{database} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatabaseUid

Output only. Public UUID of the database the snapshot was associated with.

Returns
Type
Description
string

setDatabaseUid

Output only. Public UUID of the database the snapshot was associated with.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSnapshotTime

Required. Snapshot time of the database.

Returns
Type
Description

hasSnapshotTime

clearSnapshotTime

setSnapshotTime

Required. Snapshot time of the database.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: