class Google::Cloud::Bigquery::Model::List

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

Attributes

token[RW]

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

Public Class Methods

from_gapi(gapi_list, service, dataset_id = nil, max = nil) click to toggle source

@private New Model::List from a response object.

# File lib/google/cloud/bigquery/model/list.rb, line 144
def self.from_gapi gapi_list, service, dataset_id = nil, max = nil
  models = List.new(Array(gapi_list[:models]).map { |gapi_json| Model.from_gapi_json gapi_json, service })
  models.instance_variable_set :@token,      gapi_list[:nextPageToken]
  models.instance_variable_set :@service,    service
  models.instance_variable_set :@dataset_id, dataset_id
  models.instance_variable_set :@max,        max
  models
end
new(arr = []) click to toggle source

@private Create a new Model::List with an array of models.

Calls superclass method
# File lib/google/cloud/bigquery/model/list.rb, line 32
def initialize arr = []
  super arr
end

Public Instance Methods

all(request_limit: nil, &block) click to toggle source

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 models. Default is no limit.

@yield [model] The block for accessing each model. @yieldparam [Model] model The model object.

@return [Enumerator]

@example Iterating each result by passing a block:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.models.all do |model|
  puts model.model_id
end

@example Using the enumerator by not passing a block:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

all_names = dataset.models.all.map do |model|
  model.model_id
end

@example Limit the number of API requests made:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.models.all(request_limit: 10) do |model|
  puts model.model_id
end
# File lib/google/cloud/bigquery/model/list.rb, line 127
def all request_limit: nil, &block
  request_limit = request_limit.to_i if request_limit
  return enum_for :all, request_limit: request_limit unless block_given?
  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
next() click to toggle source

Retrieve the next page of models.

@return [Model::List]

@example

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

models = dataset.models
if models.next?
  next_models = models.next
end
# File lib/google/cloud/bigquery/model/list.rb, line 72
def next
  return nil unless next?
  ensure_service!
  gapi = @service.list_models @dataset_id, token: token, max: @max
  self.class.from_gapi gapi, @service, @dataset_id, @max
end
next?() click to toggle source

Whether there is a next page of models.

@return [Boolean]

@example

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

models = dataset.models
if models.next?
  next_models = models.next
end
# File lib/google/cloud/bigquery/model/list.rb, line 52
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

Raise an error unless an active service is available.

# File lib/google/cloud/bigquery/model/list.rb, line 157
def ensure_service!
  raise "Must have active connection" unless @service
end