Reference documentation and code samples for the Cloud Spanner API class Google::Cloud::Spanner::Instance::Config::List.
Instance::Config::List is a special case Array with additional values.
Inherits
- Array
Methods
#all
def all(request_limit: nil, &block) { |config| ... } -> 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.
- request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all configs. Default is no limit.
- (config) — The block for accessing each instance config.
- config (Instance::Config) — The instance config object.
- (Enumerator)
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
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
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
#next
def next() -> Instance::Config::List
Retrieve the next page of instance configurations.
- (Instance::Config::List) — The list of instance configurations.
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new configs = spanner.instance_configs if configs.next? next_configs = configs.next end
#next?
def next?() -> Boolean
Whether there is a next page of instance configs.
- (Boolean)
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new configs = spanner.instance_configs if configs.next? next_configs = configs.next end
#token
def token()
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
#token=
def token=(value)
If not empty, indicates that there are more records that match the request and this value should be passed to continue.