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

Inherits:
Object
  • Object
show all
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:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Job

Returns a new instance of Job.



66
67
68
69
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 66

def initialize
  @grpc = nil
  @service = nil
end

Instance Attribute Details

#grpc ⇒ Object 



58
59
60
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 58

def grpc
  @grpc
end

#service ⇒ Object 



62
63
64
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 62

def service
  @service
end

Class Method Details

.from_grpc(grpc, service) ⇒ Object 



223
224
225
226
227
228
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 223

def self.from_grpc grpc, service
  new.tap do |job|
    job.instance_variable_set :@grpc, grpc
    job.instance_variable_set :@service, service
  end
end

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.



117
118
119
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 117

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:



165
166
167
168
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 165

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.



139
140
141
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 139

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:



93
94
95
96
97
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 93

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:



192
193
194
195
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 192

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



217
218
219
 
# File 'lib/google/cloud/spanner/instance/job.rb', line 217

def wait_until_done!
  @grpc.wait_until_done!
end