Class: Gcloud::Logging::ResourceDescriptor::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/logging/resource_descriptor/list.rb

Overview

ResourceDescriptor::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

ResourceDescriptor instances.



32
33
34
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 32

def initialize arr = []
  super arr
end

Instance Attribute Details

#token ⇒ Object

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



27
28
29
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 27

def token
  @token
end

Class Method Details

.from_grpc(grpc_list, service, max = nil) ⇒ Object

Google::Logging::V2::ListMonitoredResourceDescriptorsResponse object.



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 152

def self.from_grpc grpc_list, service, max = nil
  rds = new(Array(grpc_list.resource_descriptors).map do |grpc|
    ResourceDescriptor.from_grpc grpc
  end)
  token = grpc_list.next_page_token
  token = nil if token == ""
  rds.instance_variable_set "@token", token
  rds.instance_variable_set "@service", service
  rds.instance_variable_set "@max", max
  rds
end

Instance Method Details

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

Retrieves all resource descriptors by repeatedly loading #next until #next? returns ‘false`. Calls the given block once for each resource descriptor, which is passed as the parameter.

An Enumerator is returned if no block is given.

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

Examples:

Iterating each resource descriptor by passing a block:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
resource_descriptors = logging.resource_descriptors

resource_descriptors.all do |rd|
  puts rd.type
end

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
resource_descriptors = logging.resource_descriptors

all_types = resource_descriptors.all.map do |rd|
  rd.type
end

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
resource_descriptors = logging.resource_descriptors

resource_descriptors.all(request_limit: 10) do |rd|
  puts rd.type
end

Parameters:

  • request_limit (Integer) (defaults to: nil) —

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

Yields:

  • (resource_descriptor) —

    The block for accessing each resource descriptor.

Yield Parameters:

Returns:

  • (Enumerator) 


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 132

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

Retrieve the next page of resource descriptors.

Examples:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.next
end

Returns:



72
73
74
75
76
77
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 72

def next
  return nil unless next?
  ensure_service!
  list_grpc = @service.list_resource_descriptors token: token, max: @max
  self.class.from_grpc list_grpc, @service
end

#next? ⇒ Boolean

Whether there is a next page of resource descriptors.

Examples:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.next
end

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/gcloud/logging/resource_descriptor/list.rb', line 52

def next?
  !token.nil?
end