Class: Google::Cloud::ResourceManager::Project::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/resource_manager/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

#token ⇒ Object

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



26
27
28
 
# File 'lib/google/cloud/resource_manager/project/list.rb', line 26

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 project by passing a block:

require "google/cloud"

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

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

Using the enumerator by not passing a block:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
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"

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

projects.all(request_limit: 10) do |project|
  puts project.project_id
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) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/resource_manager/project/list.rb', line 128

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"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager

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

Returns:



71
72
73
74
75
 
# 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? ⇒ Boolean

Whether there is a next page of projects.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager

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

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/google/cloud/resource_manager/project/list.rb', line 51

def next?
  !token.nil?
end