Cloud Spanner V1 Client - Class CopyBackupMetadata (1.91.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupMetadata.

Metadata type for the operation returned by CopyBackup.

Generated from protobuf message google.spanner.admin.database.v1.CopyBackupMetadata

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The name of the backup being created through the copy operation. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.
↳ source_backup string

The name of the source backup that is being copied. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.
↳ progress OperationProgress

The progress of the CopyBackup operation.
↳ cancel_time Google\Protobuf\Timestamp

The time at which cancellation of CopyBackup operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

getName

The name of the backup being created through the copy operation.

Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

Returns
Type Description
string

setName

The name of the backup being created through the copy operation.

Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceBackup

The name of the source backup that is being copied.

Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

Returns
Type Description
string

setSourceBackup

The name of the source backup that is being copied.

Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

Parameter
Name Description
var string
Returns
Type Description
$this

getProgress

The progress of the CopyBackup operation.

Returns
Type Description
OperationProgress|null

hasProgress

clearProgress

setProgress

The progress of the CopyBackup operation.

Parameter
Name Description
var OperationProgress
Returns
Type Description
$this

getCancelTime

The time at which cancellation of CopyBackup operation was received.

Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCancelTime

clearCancelTime

setCancelTime

The time at which cancellation of CopyBackup operation was received.

Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this