Class: Google::Cloud::Spanner::Instance::Job

Inherits:

Object

• Object
• Google::Cloud::Spanner::Instance::Job

Defined in:

lib/google/cloud/spanner/instance/job.rb

Overview

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.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

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

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

See Also:

• Long-running Operation

Instance Method Summary

• #done? ⇒ boolean

  Checks if the processing of the instance operation is complete.

• #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 instance operation has errored.

• #instance ⇒ Google::Cloud::Spanner::Instance^?

  The instance that is the object of the operation.

• #reload! ⇒ Google::Cloud::Spanner::Instance::Job (also: #refresh!)

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

• #wait_until_done! ⇒ Object

  Reloads the job until the operation is complete.

Instance Method Details

#done? ⇒ boolean

Checks if the processing of the instance operation is complete.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

job.done? #=> false

Returns:

• (boolean) —

  true when complete, false otherwise.

# File 'lib/google/cloud/spanner/instance/job.rb', line 116

def done?
  @grpc.done?
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

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

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/instance/job.rb', line 164

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

#error? ⇒ boolean

Checks if the processing of the instance operation has errored.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

job.error? #=> false

Returns:

• (boolean) —

  true when errored, false otherwise.

# File 'lib/google/cloud/spanner/instance/job.rb', line 138

def error?
  @grpc.error?
end

#instance ⇒ Google::Cloud::Spanner::Instance^?

The instance that is the object of the operation.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

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

Returns:

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

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

# File 'lib/google/cloud/spanner/instance/job.rb', line 92

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

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

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

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

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

Returns:

• (Google::Cloud::Spanner::Instance::Job) —

  The same job instance.

# File 'lib/google/cloud/spanner/instance/job.rb', line 191

def reload!
  @grpc.reload!
  self
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

job = spanner.create_instance "my-new-instance",
                              name: "My New Instance",
                              config: "regional-us-central1",
                              nodes: 5,
                              labels: { production: :env }

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

# File 'lib/google/cloud/spanner/instance/job.rb', line 216

def wait_until_done!
  @grpc.wait_until_done!
end