google-cloud-resource_manager - Class Google::Cloud::ResourceManager::Project::List (v0.36.2)

Reference documentation and code samples for the google-cloud-resource_manager class Google::Cloud::ResourceManager::Project::List.

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |project| ... } -> 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.

Parameter
  • request_limit (Integer) (defaults to: nil) — 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 Parameter
  • project (Project) — The project object.
Returns
  • (Enumerator)
Examples

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

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

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

#next

def next() -> Project::List

Retrieve the next page of projects.

Returns
Example 
require "google/cloud/resource_manager"

resource_manager = Google::Cloud::ResourceManager.new

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

#next?

def next?() -> Boolean

Whether there is a next page of projects.

Returns
  • (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

#token

def token()

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

#token=

def token=(value)

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