Cloud Bigtable API - Class Google::Cloud::Bigtable::Instance::Job (v2.11.0)

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

Job

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

See Project#create_instance and #update.

Inherits

Google::Cloud::Bigtable::LongrunningJob

Example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

job = bigtable.create_instance(
  "my-instance",
  display_name: "Instance for user data",
  type: :DEVELOPMENT,
  labels: { "env" => "dev" }
) do |clusters|
  clusters.add "test-cluster", "us-east1-b" # nodes not allowed
end

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

# OR - Wailt until complete
job.wait_until_done!
job.done? #=> true

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

Methods

#instance

def instance() -> Google::Cloud::Bigtable::Instance, nil

Get the instance object from operation results.

Returns

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

Example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

job = bigtable.create_instance(
  "my-instance",
  display_name: "Instance for user data",
  type: :DEVELOPMENT,
  labels: { "env" => "dev" }
) do |clusters|
  clusters.add "test-cluster", "us-east1-b" # nodes not allowed
end

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

# OR
job.wait_until_done!

instance = job.instance