class Google::Cloud::Bigquery::Project::List
Project::List
is a special case Array with additional values.
Attributes
A hash of this page of results.
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 Project::List
from a response object.
# File lib/google/cloud/bigquery/project/list.rb, line 141 def self.from_gapi gapi_list, service, max = nil projects = List.new(Array(gapi_list.projects).map { |gapi_object| Project.from_gapi gapi_object, service }) projects.instance_variable_set :@token, gapi_list.next_page_token projects.instance_variable_set :@etag, gapi_list.etag projects.instance_variable_set :@service, service projects.instance_variable_set :@max, max projects end
@private Create a new Project::List
with an array of Project
instances.
# File lib/google/cloud/bigquery/project/list.rb, line 36 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 projects. Default is no limit.
@yield [project] The block for accessing each project. @yieldparam [Project] project The project object.
@return [Enumerator]
@example Iterating each result by passing a block:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new bigquery.projects.all do |project| puts project.name end
@example Using the enumerator by not passing a block:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new all_project_ids = bigquery.projects.all.map do |project| project.name end
@example Limit the number of API calls made:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new bigquery.projects.all(request_limit: 10) do |project| puts project.name end
# File lib/google/cloud/bigquery/project/list.rb, line 124 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
Retrieve the next page of projects.
@return [Project::List]
@example
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new projects = bigquery.projects if projects.next? next_projects = projects.next end
# File lib/google/cloud/bigquery/project/list.rb, line 72 def next return nil unless next? ensure_service! gapi = @service.list_projects token: token, max: @max self.class.from_gapi gapi, @service, @max end
Whether there is a next page of projects.
@return [Boolean]
@example
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new projects = bigquery.projects if projects.next? next_projects = projects.next end
# File lib/google/cloud/bigquery/project/list.rb, line 54 def next? !token.nil? end
Protected Instance Methods
Raise an error unless an active service is available.
# File lib/google/cloud/bigquery/project/list.rb, line 154 def ensure_service! raise "Must have active connection" unless @service end