Class: Gcloud::Pubsub::Topic::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/pubsub/topic/list.rb

Overview

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

Returns a new instance of List.



32
33
34
 
# File 'lib/gcloud/pubsub/topic/list.rb', line 32

def initialize arr = []
  super arr
end

Instance Attribute Details

#token ⇒ Object

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



28
29
30
 
# File 'lib/gcloud/pubsub/topic/list.rb', line 28

def token
  @token
end

Class Method Details

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

object.



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/gcloud/pubsub/topic/list.rb', line 151

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

Instance Method Details

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

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

An Enumerator is returned if no block is given.

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

Examples:

Iterating each topic by passing a block:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
topics.all do |topic|
  puts topic.name
end

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
all_names = topics.all.map do |topic|
  topic.name
end

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
topics.all(request_limit: 10) do |topic|
  puts topic.name
end

Parameters:

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

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

Yields:

  • (topic) —

    The block for accessing each topic.

Yield Parameters:

  • topic (Topic) —

    The topic object.

Returns:

  • (Enumerator) 


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

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

Retrieve the next page of topics.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
if topics.next?
  next_topics = topics.next
end

Returns:



72
73
74
75
76
77
78
 
# File 'lib/gcloud/pubsub/topic/list.rb', line 72

def next
  return nil unless next?
  ensure_service!
  options = { token: token, max: @max }
  grpc = @service.list_topics options
  self.class.from_grpc grpc, @service, @max
end

#next? ⇒ Boolean

Whether there a next page of topics.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
if topics.next?
  next_topics = topics.next
end

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/gcloud/pubsub/topic/list.rb', line 52

def next?
  !token.nil?
end