Class: Google::Cloud::Spanner::Backup::Restore::Job

Inherits:

Object

• Object
• Google::Cloud::Spanner::Backup::Restore::Job

Defined in:

lib/google/cloud/spanner/backup/restore/job.rb

Overview

Job

A resource representing the long-running, asynchronous processing of a backup restore. The job can be refreshed to retrieve the restored database object once the operation has been completed.

See Google::Cloud::Spanner::Backup#restore

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.done? #=> false
job.reload! # API call
job.done? #=> true

if job.error?
  status = job.error
else
  database = job.database
end

See Also:

• Long-running Operation

Instance Method Summary

• #database ⇒ Database^?

  The database is the object of the operation.

• #done? ⇒ boolean

  Checks if the processing of the restore operation is complete.

• #end_time ⇒ Time^?

  The operation end time.

• #error ⇒ Google::Cloud::Spanner::Status^?

  The status if the operation associated with this job produced an error.

• #error? ⇒ boolean

  Checks if the processing of the restore operation has errored.

• #progress_percent ⇒ Integer

  The operation progress in percentage.

• #reload! ⇒ Backup::Job (also: #refresh!)

  Reloads the job with current data from the long-running, asynchronous processing of a restore operation.

• #start_time ⇒ Time^?

  The operation start time.

• #wait_until_done! ⇒ Object

  Reloads the job until the operation is complete.

Instance Method Details

#database ⇒ Database^?

The database is the object of the operation.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.done? #=> false
job.reload!
job.done? #=> true
database = job.database

Returns:

• (Database, nil) —

  The database instance, or nil if the operation is not complete.

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 90

def database
  return nil unless done?
  return nil unless @grpc.grpc_op.result == :response
  Database.from_grpc @grpc.results, service
end

#done? ⇒ boolean

Checks if the processing of the restore operation is complete.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.done? #=> false

Returns:

• (boolean) —

  true when complete, false otherwise.

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 112

def done?
  @grpc.done?
end

#end_time ⇒ Time^?

The operation end time.

Returns:

• (Time, nil)

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 228

def end_time
  return nil unless @grpc.metadata.progress.end_time
  Convert.timestamp_to_time @grpc.metadata.progress.end_time
end

#error ⇒ Google::Cloud::Spanner::Status^?

The status if the operation associated with this job produced an error.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.error? # true

error = job.error

Returns:

• (Google::Cloud::Spanner::Status, nil) —

  A status object with the status code and message, or nil if no error occurred.

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 156

def error
  return nil unless error?
  Google::Cloud::Spanner::Status.from_grpc @grpc.error
end

#error? ⇒ boolean

Checks if the processing of the restore operation has errored.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.error? #=> false

Returns:

• (boolean) —

  true when errored, false otherwise.

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 132

def error?
  @grpc.error?
end

#progress_percent ⇒ Integer

The operation progress in percentage.

Returns:

• (Integer)

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 211

def progress_percent
  @grpc.metadata.progress.progress_percent
end

#reload! ⇒ Backup::Job Also known as: refresh!

Reloads the job with current data from the long-running, asynchronous processing of a restore operation.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.done? #=> false
job.reload! # API call
job.done? #=> true

Returns:

• (Backup::Job) —

  The same job instance.

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 180

def reload!
  @grpc.reload!
  self
end

#start_time ⇒ Time^?

The operation start time.

Returns:

• (Time, nil)

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 219

def start_time
  return nil unless @grpc.metadata.progress.start_time
  Convert.timestamp_to_time @grpc.metadata.progress.start_time
end

#wait_until_done! ⇒ Object

Reloads the job until the operation is complete. The delay between reloads will incrementally increase.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backup = instance.backup "my-backup"
job = backup.restore "my-restored-database"

job.done? #=> false
job.wait_until_done!
job.done? #=> true

# File 'lib/google/cloud/spanner/backup/restore/job.rb', line 203

def wait_until_done!
  @grpc.wait_until_done!
end