Class: Google::Cloud::Spanner::Instance::List
- Inherits:
-
Array
- Object
- Array
- Google::Cloud::Spanner::Instance::List
- Defined in:
- lib/google/cloud/spanner/instance/list.rb
Overview
Instance::List is a special case Array with additional values.
Instance Attribute Summary collapse
-
#token ⇒ Object
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Class Method Summary collapse
-
.from_grpc(grpc, service, max = nil) ⇒ Object
Google::Spanner::Admin::Instance::V1::ListInstancesResponse object.
Instance Method Summary collapse
- #all(request_limit: nil) {|instance| ... } ⇒ Enumerator
-
#initialize(arr = []) ⇒ List
constructor
Instance instances.
-
#next ⇒ Instance::List
Retrieve the next page of instances.
-
#next? ⇒ Boolean
Whether there is a next page of instances.
Constructor Details
#initialize(arr = []) ⇒ List
Instance instances.
34 35 36 |
# File 'lib/google/cloud/spanner/instance/list.rb', line 34 def initialize arr = [] super arr end |
Instance Attribute Details
#token ⇒ Object
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 |
Class Method Details
.from_grpc(grpc, service, max = nil) ⇒ Object
Google::Spanner::Admin::Instance::V1::ListInstancesResponse object.
144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/google/cloud/spanner/instance/list.rb', line 144 def self.from_grpc grpc, service, max = nil instances = List.new(Array(grpc.instances).map do |instance| Instance.from_grpc instance, service end) token = grpc.next_page_token token = nil if token == "" instances.instance_variable_set :@token, token instances.instance_variable_set :@service, service instances.instance_variable_set :@max, max instances 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.
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 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 { |r| yield r } if request_limit request_limit -= 1 break if request_limit < 0 end break unless results.next? results = results.next end end |
#next ⇒ Instance::List
Retrieve the next page of instances.
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! = { token: token, max: @max } grpc = @service.list_instances self.class.from_grpc grpc, @service, @max end |
#next? ⇒ Boolean
Whether there is a next page of instances.
52 53 54 |
# File 'lib/google/cloud/spanner/instance/list.rb', line 52 def next? !token.nil? end |