class Google::Cloud::PubSub::Topic::List
Topic::List
is a special case Array with additional values.
Attributes
If not empty, indicates that there are more topics that match the request and this value should be passed to the next {Google::Cloud::PubSub::Project#topics} to continue.
Public Class Methods
@private New Topic::List
from a Google::Cloud::PubSub::V1::ListTopicsResponse object.
# File lib/google/cloud/pubsub/topic/list.rb, line 145 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 == "".freeze topics.instance_variable_set :@token, token topics.instance_variable_set :@service, service topics.instance_variable_set :@max, max topics end
@private Create a new Topic::List
with an array of values.
# File lib/google/cloud/pubsub/topic/list.rb, line 33 def initialize arr = [] super arr end
Public Instance Methods
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.
@param [Integer] request_limit The upper limit of API requests to
make to load all topics. Default is no limit.
@yield [topic] The block for accessing each topic. @yieldparam [Topic] topic The topic object.
@return [Enumerator]
@example Iterating each topic by passing a block:
require "google/cloud/pubsub" pubsub = Google::Cloud::PubSub.new topics = pubsub.topics topics.all do |topic| puts topic.name end
@example Using the enumerator by not passing a block:
require "google/cloud/pubsub" pubsub = Google::Cloud::PubSub.new topics = pubsub.topics all_names = topics.all.map do |topic| topic.name end
@example Limit the number of API calls made:
require "google/cloud/pubsub" pubsub = Google::Cloud::PubSub.new topics = pubsub.topics topics.all(request_limit: 10) do |topic| puts topic.name end
# File lib/google/cloud/pubsub/topic/list.rb, line 127 def all request_limit: nil, &block request_limit = request_limit.to_i if request_limit return enum_for :all, request_limit: request_limit unless block_given? results = self loop do results.each(&block) if request_limit request_limit -= 1 break if request_limit.negative? end break unless results.next? results = results.next end end
Retrieve the next page of topics.
@return [Topic::List]
@example
require "google/cloud/pubsub" pubsub = Google::Cloud::PubSub.new topics = pubsub.topics if topics.next? next_topics = topics.next end
# File lib/google/cloud/pubsub/topic/list.rb, line 71 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
Whether there a next page of topics.
@return [Boolean]
@example
require "google/cloud/pubsub" pubsub = Google::Cloud::PubSub.new topics = pubsub.topics if topics.next? next_topics = topics.next end
# File lib/google/cloud/pubsub/topic/list.rb, line 52 def next? !token.nil? end
Protected Instance Methods
@private Raise an error unless an active connection to the service is available.
# File lib/google/cloud/pubsub/topic/list.rb, line 162 def ensure_service! raise "Must have active connection to service" unless @service end