Reference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupMetadata.
Metadata type for the google.longrunning.Operation returned by CopyBackup.
Generated from protobuf message google.spanner.admin.database.v1.CopyBackupMetadata
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 |
↳ source_backup |
string
The name of the source backup that is being copied. Values are of the form |
↳ progress |
Google\Cloud\Spanner\Admin\Database\V1\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 |
getName
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Generated from protobuf field string name = 1 [(.google.api.resource_reference) = {
| 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>.
Generated from protobuf field string name = 1 [(.google.api.resource_reference) = {
| 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>.
Generated from protobuf field string source_backup = 2 [(.google.api.resource_reference) = {
| 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>.
Generated from protobuf field string source_backup = 2 [(.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
The progress of the CopyBackup 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 CopyBackup 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 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.
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 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.
Generated from protobuf field .google.protobuf.Timestamp cancel_time = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |