Cloud Bigtable API - Class Google::Cloud::Bigtable::Backup::Job (v2.10.1)

Reference documentation and code samples for the Cloud Bigtable API class Google::Cloud::Bigtable::Backup::Job.

Job

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

See Cluster#create_backup.

Inherits

Google::Cloud::Bigtable::LongrunningJob

Example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new
instance = bigtable.instance "my-instance"
cluster = instance.cluster "my-cluster"
table = instance.table "my-table"

expire_time = Time.now + 60 * 60 * 7
job = cluster.create_backup table, "my-backup", expire_time

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

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

Methods

#backup

def backup() -> Google::Cloud::Bigtable::Backup, nil

Get the backup object from operation results.

Returns

(Google::Cloud::Bigtable::Backup, nil) — The backup instance, or nil if the operation is not complete.

Example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new
instance = bigtable.instance "my-instance"
cluster = instance.cluster "my-cluster"
table = instance.table "my-table"

expire_time = Time.now + 60 * 60 * 7
job = cluster.create_backup table, "my-backup", expire_time

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

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