Class: Google::Apis::SpannerV1::RestoreDatabaseMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestoreDatabaseMetadata

Returns a new instance of RestoreDatabaseMetadata.



2629
2630
2631
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2629

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#backup_info ⇒ Google::Apis::SpannerV1::BackupInfo

Information about a backup. Corresponds to the JSON property backupInfo

Returns:



2586
2587
2588
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2586

def backup_info
  @backup_info
end

#cancel_time ⇒ String

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. Corresponds to the JSON property cancelTime

Returns:

  • (String) 


2598
2599
2600
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2598

def cancel_time
  @cancel_time
end

#name ⇒ String

Name of the database being created and restored to. Corresponds to the JSON property name

Returns:

  • (String) 


2603
2604
2605
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2603

def name
  @name
end

#optimize_database_operation_name ⇒ 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//instances//databases//operations/ 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. Corresponds to the JSON property optimizeDatabaseOperationName

Returns:

  • (String) 


2616
2617
2618
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2616

def optimize_database_operation_name
  @optimize_database_operation_name
end

#progress ⇒ Google::Apis::SpannerV1::OperationProgress

Encapsulates progress related information for a Cloud Spanner long running operation. Corresponds to the JSON property progress

Returns:



2622
2623
2624
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2622

def progress
  @progress
end

#source_type ⇒ String

The type of the restore source. Corresponds to the JSON property sourceType

Returns:

  • (String) 


2627
2628
2629
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2627

def source_type
  @source_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2634
2635
2636
2637
2638
2639
2640
2641
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2634

def update!(**args)
  @backup_info = args[:backup_info] if args.key?(:backup_info)
  @cancel_time = args[:cancel_time] if args.key?(:cancel_time)
  @name = args[:name] if args.key?(:name)
  @optimize_database_operation_name = args[:optimize_database_operation_name] if args.key?(:optimize_database_operation_name)
  @progress = args[:progress] if args.key?(:progress)
  @source_type = args[:source_type] if args.key?(:source_type)
end