Cloud Spanner V1 Client - Class CreateBackupMetadata (1.54.2)

Version 1.54.2

• 1.88.0 (latest)
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

Metadata type for the operation returned by CreateBackup.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string The name of the backup being created.
↳ database	string The name of the database the backup is created from.
↳ progress	Google\Cloud\Spanner\Admin\Database\V1\OperationProgress The progress of the CreateBackup operation.
↳ cancel_time	Google\Protobuf\Timestamp The time at which cancellation of this 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.

Generated from protobuf field string name = 1 [(.google.api.resource_reference) = {

Returns
Type	Description
string

setName

The name of the backup being created.

Generated from protobuf field string name = 1 [(.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDatabase

The name of the database the backup is created from.

Generated from protobuf field string database = 2 [(.google.api.resource_reference) = {

Returns
Type	Description
string

setDatabase

The name of the database the backup is created from.

Generated from protobuf field string database = 2 [(.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getProgress

The progress of the CreateBackup operation.

Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3;

Returns
Type	Description
Google\Cloud\Spanner\Admin\Database\V1\OperationProgress|null

hasProgress

clearProgress

setProgress

The progress of the CreateBackup operation.

Generated from protobuf field .google.spanner.admin.database.v1.OperationProgress progress = 3;

Parameter
Name	Description
var	Google\Cloud\Spanner\Admin\Database\V1\OperationProgress

Returns
Type	Description
$this

getCancelTime

The time at which cancellation of this 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.

Generated from protobuf field .google.protobuf.Timestamp cancel_time = 4;

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCancelTime

clearCancelTime

setCancelTime

The time at which cancellation of this 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.

Generated from protobuf field .google.protobuf.Timestamp cancel_time = 4;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this