Class: Google::Cloud::Spanner::Instance::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/spanner/instance/list.rb

Overview

Instance::List is a special case Array with additional values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#tokenObject

If not empty, indicates that there are more records that match the request and this value should be passed to continue.


29
30
31
# File 'lib/google/cloud/spanner/instance/list.rb', line 29

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|instance| ... } ⇒ Enumerator

Retrieves remaining results by repeatedly invoking #next until #next? returns false. Calls the given block once for each result, which is passed as the argument to the block.

An Enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved. (Unlike #each, for example, which merely iterates over the results returned by a single API call.) Use with caution.

Examples:

Iterating each instance by passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

spanner.instances.all do |instance|
  puts instance.instance_id
end

Using the enumerator by not passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

all_instance_ids = spanner.instances.all.map do |instance|
  instance.instance_id
end

Limit the number of API calls made:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

spanner.instances.all(request_limit: 10) do |instance|
  puts instance.instance_id
end

Parameters:

  • request_limit (Integer) (defaults to: nil)

    The upper limit of API requests to make to load all instances. Default is no limit.

Yields:

  • (instance)

    The block for accessing each instance.

Yield Parameters:

  • instance (Instance)

    The instance object.

Returns:

  • (Enumerator)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/google/cloud/spanner/instance/list.rb', line 123

def all request_limit: nil, &block
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for :all, request_limit: request_limit
  end
  results = self
  loop do
    results.each(&block)
    if request_limit
      request_limit -= 1
      break if request_limit.negative?
    end
    break unless results.next?
    results = results.next
  end
end

#nextInstance::List

Retrieve the next page of instances.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instances = spanner.instances
if instances.next?
  next_instances = instances.next
end

Returns:


70
71
72
73
74
75
76
# File 'lib/google/cloud/spanner/instance/list.rb', line 70

def next
  return nil unless next?
  ensure_service!
  options = { token: token, max: @max }
  grpc = @service.list_instances(**options)
  self.class.from_grpc grpc, @service, @max
end

#next?Boolean

Whether there is a next page of instances.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instances = spanner.instances
if instances.next?
  next_instances = instances.next
end

Returns:

  • (Boolean)

52
53
54
# File 'lib/google/cloud/spanner/instance/list.rb', line 52

def next?
  !token.nil?
end