Class: Google::Cloud::Bigquery::Project::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/bigquery/project/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#etag ⇒ Object

A hash of this page of results.



31
32
33
 
# File 'lib/google/cloud/bigquery/project/list.rb', line 31

def etag
  @etag
end

#token ⇒ Object

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



28
29
30
 
# File 'lib/google/cloud/bigquery/project/list.rb', line 28

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|project| ... } ⇒ Enumerator

Retrieves all projects by repeatedly loading #next until #next? returns false. Calls the given block once for each project, which is passed as the parameter.

An Enumerator is returned if no block is given.

This method may make several API calls until all projects are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.

Examples:

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

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

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

Parameters:

  • request_limit (Integer) —

    The upper limit of API requests to make to load all projects. Default is no limit.

Yields:

  • (project) —

    The block for accessing each project.

Yield Parameters:

  • project (Project) —

    The project object.

Returns:

  • (Enumerator) 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/bigquery/project/list.rb', line 125

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 ⇒ Project::List

Retrieve the next page of projects.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

projects = bigquery.projects
if projects.next?
  next_projects = projects.next
end

Returns:



72
73
74
75
76
77
78
 
# File 'lib/google/cloud/bigquery/project/list.rb', line 72

def next
  return nil unless next?
  ensure_service!
  options = { all: @hidden, token: token, max: @max }
  gapi = @service.list_projects options
  self.class.from_gapi gapi, @service, @max
end

#next? ⇒ Boolean

Whether there is a next page of projects.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

projects = bigquery.projects
if projects.next?
  next_projects = projects.next
end

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/google/cloud/bigquery/project/list.rb', line 54

def next?
  !token.nil?
end