Class: Google::Spanner::Admin::Database::V1::RestoreDatabaseMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb

Overview

Metadata type for the long-running operation returned by RestoreDatabase.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_info ⇒ Google::Spanner::Admin::Database::V1::BackupInfo

Returns Information about the backup used to restore the database.

Returns:



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end

#cancel_time ⇒ Google::Protobuf::Timestamp

Returns 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 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 Rpc::Status#code of 1, corresponding to Code.CANCELLED.



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end

#name ⇒ String

Returns Name of the database being created and restored to.

Returns:

  • (String) —

    Name of the database being created and restored to.



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end

#optimize_database_operation_name ⇒ String

Returns 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 is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

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 is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end

#progress ⇒ Google::Spanner::Admin::Database::V1::OperationProgress

Returns The progress of the RestoreDatabase operation.

Returns:

  • (Google::Spanner::Admin::Database::V1::OperationProgress) —

    The progress of the RestoreDatabase operation.



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end

#source_type ⇒ Google::Spanner::Admin::Database::V1::RestoreSourceType

Returns The type of the restore source.

Returns:



354
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 354

class RestoreDatabaseMetadata; end