Class: Gcloud::ResourceManager::Project::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/resource_manager/project/list.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

instances.



30
31
32
 
# File 'lib/gcloud/resource_manager/project/list.rb', line 30

def initialize arr = []
  super arr
end

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.



25
26
27
 
# File 'lib/gcloud/resource_manager/project/list.rb', line 25

def token
  @token
end

Class Method Details

.from_gapi(gapi_list, manager, filter = nil, max = nil) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/gcloud/resource_manager/project/list.rb', line 146

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

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 "gcloud"

gcloud = Gcloud.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 "gcloud"

gcloud = Gcloud.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 "gcloud"

gcloud = Gcloud.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) (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 Parameters:

  • project (Project) —

    The project object.

Returns:

  • (Enumerator) 


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

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 "gcloud"

gcloud = Gcloud.new
resource_manager = gcloud.resource_manager

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

Returns:



70
71
72
73
74
 
# File 'lib/gcloud/resource_manager/project/list.rb', line 70

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 "gcloud"

gcloud = Gcloud.new
resource_manager = gcloud.resource_manager

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

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/gcloud/resource_manager/project/list.rb', line 50

def next?
  !token.nil?
end