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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/backup/job.rb,
lib/google/cloud/spanner/backup/job/list.rb

Overview

Job

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

See Database#create_backup

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

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

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

See Also:

Defined Under Namespace

Classes: List

Instance Method Summary collapse

Instance Method Details

#backup ⇒ Backup?

The backup is the object of the operation.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

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

Returns:

  • (Backup, nil) —

    The backup, or nil if the operation is not complete.



90
91
92
93
94
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 90

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

#cancel ⇒ Object

Cancel the backup job.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

job.done? #=> false
job.cancel


223
224
225
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 223

def cancel
  @grpc.cancel
end

#cancel_time ⇒ Time?

The operation canceled time.

Returns:

  • (Time, nil) 


257
258
259
260
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 257

def cancel_time
  return nil unless @grpc.metadata.cancel_time
  Convert.timestamp_to_time @grpc.metadata.cancel_time
end

#done? ⇒ boolean

Checks if the processing of the backup operation is complete.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

job.done? #=> false

Returns:

  • (boolean) —

    true when complete, false otherwise.



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

def done?
  @grpc.done?
end

#end_time ⇒ Time?

The operation end time.

Returns:

  • (Time, nil) 


248
249
250
251
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 248

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

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

job.error? # true

error = job.error

Returns:



156
157
158
159
 
# File 'lib/google/cloud/spanner/backup/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 backup operation has errored.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

job.error? #=> false

Returns:

  • (boolean) —

    true when errored, false otherwise.



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

def error?
  @grpc.error?
end

#progress_percent ⇒ Integer

The operation progress in percentage.

Returns:

  • (Integer) 


231
232
233
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 231

def progress_percent
  @grpc.metadata.progress.progress_percent
end

#reload! ⇒ Google::Cloud::Spanner::Backup::Job Also known as: refresh!

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

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

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

Returns:



181
182
183
184
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 181

def reload!
  @grpc.reload!
  self
end

#start_time ⇒ Time?

The operation start time.

Returns:

  • (Time, nil) 


239
240
241
242
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 239

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

database = spanner.database "my-instance", "my-database"
expire_time = Time.now + 36000
job = database.create_backup "my-backup", expire_time

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


204
205
206
 
# File 'lib/google/cloud/spanner/backup/job.rb', line 204

def wait_until_done!
  @grpc.wait_until_done!
end