Cloud Firestore V1 Client - Class CloneDatabaseMetadata (1.53.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class CloneDatabaseMetadata.

Metadata for the long-running operation from the CloneDatabase request.

Generated from protobuf message google.firestore.admin.v1.CloneDatabaseMetadata

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ start_time`	`Google\Protobuf\Timestamp` The time the clone was started.
`↳ end_time`	`Google\Protobuf\Timestamp` The time the clone finished, unset for ongoing clones.
`↳ operation_state`	`int` The operation state of the clone.
`↳ database`	`string` The name of the database being cloned to.
`↳ pitr_snapshot`	`PitrSnapshot` The snapshot from which this database was cloned.
`↳ progress_percentage`	`Progress` How far along the clone is as an estimated percentage of remaining time.

getStartTime

The time the clone was started.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

The time the clone was started.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

The time the clone finished, unset for ongoing clones.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

The time the clone finished, unset for ongoing clones.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getOperationState

The operation state of the clone.

Returns
Type	Description
`int`

setOperationState

The operation state of the clone.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDatabase

The name of the database being cloned to.

Returns
Type	Description
`string`

setDatabase