class Google::Cloud::PubSub::Subscription::List

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

Attributes

token[RW]

If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next {Google::Cloud::PubSub::Topic#subscriptions} to continue.

Public Class Methods

from_grpc(grpc_list, service, max = nil) click to toggle source

@private New Subscriptions::List from a Google::Cloud::PubSub::V1::ListSubscriptionsRequest object.

# File lib/google/cloud/pubsub/subscription/list.rb, line 151
def self.from_grpc grpc_list, service, max = nil
  subs = new(Array(grpc_list.subscriptions).map do |grpc|
    Subscription.from_grpc grpc, service
  end)
  token = grpc_list.next_page_token
  token = nil if token == "".freeze
  subs.instance_variable_set :@token,   token
  subs.instance_variable_set :@service, service
  subs.instance_variable_set :@max,     max
  subs
end
from_topic_grpc(grpc_list, service, topic, max = nil) click to toggle source

@private New Subscriptions::List from a Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse object.

# File lib/google/cloud/pubsub/subscription/list.rb, line 166
def self.from_topic_grpc grpc_list, service, topic, max = nil
  subs = new(Array(grpc_list.subscriptions).map do |grpc|
    Subscription.from_name grpc, service
  end)
  token = grpc_list.next_page_token
  token = nil if token == "".freeze
  subs.instance_variable_set :@token,   token
  subs.instance_variable_set :@service, service
  subs.instance_variable_set :@topic,   topic
  subs.instance_variable_set :@max,     max
  subs
end
new(arr = []) click to toggle source

@private Create a new Subscription::List with an array of values.

Calls superclass method
# File lib/google/cloud/pubsub/subscription/list.rb, line 33
def initialize arr = []
  @topic = nil
  @prefix = nil
  @token = nil
  @max = nil
  super arr
end

Public Instance Methods

all(request_limit: nil, &block) click to toggle source

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 subscriptions. Default is no limit.

@yield [subscription] The block for accessing each subscription. @yieldparam [Subscription] subscription The subscription object.

@return [Enumerator]

@example Iterating each subscription by passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
subscriptions.all do |subscription|
  puts subscription.name
end

@example Using the enumerator by not passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
all_names = subscriptions.all.map do |subscription|
  subscription.name
end

@example Limit the number of API calls made:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
subscriptions.all(request_limit: 10) do |subscription|
  puts subscription.name
end
# File lib/google/cloud/pubsub/subscription/list.rb, line 133
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
next() click to toggle source

Retrieve the next page of subscriptions.

@return [Subscription::List]

@example

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end
# File lib/google/cloud/pubsub/subscription/list.rb, line 75
def next
  return nil unless next?
  ensure_service!
  if @topic
    next_topic_subscriptions
  else
    next_subscriptions
  end
end
next?() click to toggle source

Whether there a next page of subscriptions.

@return [Boolean]

@example

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end
# File lib/google/cloud/pubsub/subscription/list.rb, line 56
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

@private Raise an error unless an active connection to the service is available.

# File lib/google/cloud/pubsub/subscription/list.rb, line 184
def ensure_service!
  raise "Must have active connection to service" unless @service
end
next_subscriptions() click to toggle source
# File lib/google/cloud/pubsub/subscription/list.rb, line 188
def next_subscriptions
  options = { prefix: @prefix, token: @token, max: @max }
  grpc = @service.list_subscriptions options
  self.class.from_grpc grpc, @service, @max
end
next_topic_subscriptions() click to toggle source
# File lib/google/cloud/pubsub/subscription/list.rb, line 194
def next_topic_subscriptions
  options = { token: @token, max: @max }
  grpc = @service.list_topics_subscriptions @topic, options
  self.class.from_topic_grpc grpc, @service, @topic, @max
end