Class: Google::Cloud::Pubsub::Subscription::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/pubsub/subscription/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#token ⇒ Object

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



29
30
31
 
# File 'lib/google/cloud/pubsub/subscription/list.rb', line 29

def token
  @token
end

Instance Method Details

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

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

An Enumerator is returned if no block is given.

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

Examples:

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

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

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

Parameters:

  • request_limit (Integer) —

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

Yields:

  • (subscription) —

    The block for accessing each subscription.

Yield Parameters:

Returns:

  • (Enumerator) 


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/google/cloud/pubsub/subscription/list.rb', line 133

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

Retrieve the next page of subscriptions.

Examples:

require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end

Returns:



75
76
77
78
79
80
81
82
83
 
# 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? ⇒ Boolean

Whether there a next page of subscriptions.

Examples:

require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/google/cloud/pubsub/subscription/list.rb', line 56

def next?
  !token.nil?
end