Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata.
Metadata type for the long-running operation returned by RestoreDatabase.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_info
def backup_info() -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupInfo Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::BackupInfo) — Information about the backup used to restore the database.
#backup_info=
def backup_info=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupInfo Parameter
- value (::Google::Cloud::Spanner::Admin::Database::V1::BackupInfo) — Information about the backup used to restore the database.
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::BackupInfo) — Information about the backup used to restore the database.
#cancel_time
def cancel_time() -> ::Google::Protobuf::Timestamp Returns
- (::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.
#cancel_time=
def cancel_time=(value) -> ::Google::Protobuf::Timestamp Parameter
- value (::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.
Returns
- (::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.
#name
def name() -> ::String Returns
- (::String) — Name of the database being created and restored to.
#name=
def name=(value) -> ::String Parameter
- value (::String) — Name of the database being created and restored to.
Returns
- (::String) — Name of the database being created and restored to.
#optimize_database_operation_name
def optimize_database_operation_name() -> ::String Returns
- (::String) — If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>where the
#optimize_database_operation_name=
def optimize_database_operation_name=(value) -> ::String Parameter
- value (::String) — If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>where the
Returns
- (::String) — If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>where the
#progress
def progress() -> ::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress) — The progress of the RestoreDatabase operation.
#progress=
def progress=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress Parameter
- value (::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress) — The progress of the RestoreDatabase operation.
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress) — The progress of the RestoreDatabase operation.
#source_type
def source_type() -> ::Google::Cloud::Spanner::Admin::Database::V1::RestoreSourceType Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::RestoreSourceType) — The type of the restore source.
#source_type=
def source_type=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::RestoreSourceType Parameter
- value (::Google::Cloud::Spanner::Admin::Database::V1::RestoreSourceType) — The type of the restore source.
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::RestoreSourceType) — The type of the restore source.