class Google::Cloud::Spanner::Instance::Config::List
Instance::Config::List
is a special case Array with additional values.
Attributes
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Public Class Methods
@private New Instance::Config::List
from a `Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse` object.
# File lib/google/cloud/spanner/instance/config/list.rb, line 147 def self.from_grpc grpc, service, max = nil configs = List.new(Array(grpc.instance_configs).map do |config| Instance::Config.from_grpc config end) token = grpc.next_page_token token = nil if token == "".freeze configs.instance_variable_set :@token, token configs.instance_variable_set :@service, service configs.instance_variable_set :@max, max configs end
@private Create a new Instance::Config::List
with an array of Instance::Config
instances.
# File lib/google/cloud/spanner/instance/config/list.rb, line 35 def initialize arr = [] super arr end
Public Instance Methods
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.
@param [Integer] request_limit The upper limit of API requests to
make to load all configs. Default is no limit.
@yield [config] The block for accessing each instance config. @yieldparam [Instance::Config] config The instance config object.
@return [Enumerator]
@example Iterating each instance config by passing a block:
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new spanner.instance_configs.all do |config| puts config.instance_config_id end
@example Using the enumerator by not passing a block:
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new all_config_ids = spanner.instance_configs.all.map do |config| config.instance_config_id end
@example Limit the number of API calls made:
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new spanner.instance_configs.all(request_limit: 10) do |config| puts config.instance_config_id end
# File lib/google/cloud/spanner/instance/config/list.rb, line 126 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
Retrieve the next page of instance configurations.
@return [Instance::Config::List] The list of instance
configurations.
@example
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new configs = spanner.instance_configs if configs.next? next_configs = configs.next end
# File lib/google/cloud/spanner/instance/config/list.rb, line 72 def next return nil unless next? ensure_service! options = { token: token, max: @max } grpc = @service.list_instance_configs(**options) self.class.from_grpc grpc, @service, @max end
Whether there is a next page of instance configs.
@return [Boolean]
@example
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new configs = spanner.instance_configs if configs.next? next_configs = configs.next end
# File lib/google/cloud/spanner/instance/config/list.rb, line 53 def next? !token.nil? end
Protected Instance Methods
Raise an error unless an active service is available.
# File lib/google/cloud/spanner/instance/config/list.rb, line 163 def ensure_service! raise "Must have active connection" unless @service end