class Google::Cloud::ResourceManager::Project::List

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

Attributes

token[RW]

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

Public Class Methods

from_gapi(gapi_list, manager, filter = nil, max = nil) click to toggle source

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

# File lib/google/cloud/resource_manager/project/list.rb, line 144
def self.from_gapi gapi_list, manager, filter = nil, max = nil
  projects = new(Array(gapi_list.projects).map do |gapi_object|
    Project.from_gapi gapi_object, manager.service
  end)
  projects.instance_variable_set :@token,   gapi_list.next_page_token
  projects.instance_variable_set :@manager, manager
  projects.instance_variable_set :@filter,  filter
  projects.instance_variable_set :@max,     max
  projects
end
new(arr = []) click to toggle source

@private Create a new Project::List with an array of Project instances.

Calls superclass method
# File lib/google/cloud/resource_manager/project/list.rb, line 33
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 projects. Default is no limit.

@yield [project] The block for accessing each project. @yieldparam [Project] project The project object.

@return [Enumerator]

@example Iterating each project by passing a block:

require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new
projects = resource_manager.projects

projects.all do |project|
  puts project.project_id
end

@example Using the enumerator by not passing a block:

require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new
projects = resource_manager.projects

all_project_ids = projects.all.map do |project|
  project.project_id
end

@example Limit the number of API calls made:

require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new
projects = resource_manager.projects

projects.all(request_limit: 10) do |project|
  puts project.project_id
end
# File lib/google/cloud/resource_manager/project/list.rb, line 125
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
next() click to toggle source

Retrieve the next page of projects.

@return [Project::List]

@example

require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new

projects = resource_manager.projects
if projects.next?
  next_projects = projects.next
end
# File lib/google/cloud/resource_manager/project/list.rb, line 71
def next
  return nil unless next?
  ensure_manager!
  @manager.projects token: token, filter: @filter, max: @max
end
next?() click to toggle source

Whether there is a next page of projects.

@return [Boolean]

@example

require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new

projects = resource_manager.projects
if projects.next?
  next_projects = projects.next
end
# File lib/google/cloud/resource_manager/project/list.rb, line 52
def next?
  !token.nil?
end

Protected Instance Methods

ensure_manager!() click to toggle source

Raise an error unless an active connection is available.

# File lib/google/cloud/resource_manager/project/list.rb, line 159
def ensure_manager!
  raise "Must have active connection" unless @manager
end