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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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::Cloud::Spanner::Admin::Database::V1::BackupInfo

Returns Information about the backup used to restore the database.

Returns:



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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 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.



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Name of the database being created and restored to.

Returns:

  • (::String) —

    Name of the database being created and restored to.



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns The progress of the RestoreDatabase operation.

Returns:



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns The type of the restore source.

Returns:



625
626
627
628
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 625

class RestoreDatabaseMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end