Class: Google::Cloud::Dns::Change::List
- Inherits:
-
Array
- Object
- Array
- Google::Cloud::Dns::Change::List
- Defined in:
- lib/google/cloud/dns/change/list.rb
Overview
Change::List is a special case Array with additional values.
Instance Attribute Summary collapse
-
#token ⇒ Object
If not empty, indicates that there are more changes that match the request and this value should be passed to continue.
Instance Method Summary collapse
- #all(request_limit: nil) {|change| ... } ⇒ Enumerator
-
#next ⇒ Change::List
Retrieve the next page of changes.
-
#next? ⇒ Boolean
Whether there a next page of changes.
Instance Attribute Details
#token ⇒ Object
If not empty, indicates that there are more changes that match the request and this value should be passed to continue.
28 29 30 |
# File 'lib/google/cloud/dns/change/list.rb', line 28 def token @token end |
Instance Method Details
#all(request_limit: nil) {|change| ... } ⇒ Enumerator
Retrieves all changes by repeatedly loading #next until #next?
returns false
. Calls the given block once for each change, which
is passed as the parameter.
An Enumerator is returned if no block is given.
This method may make several API calls until all changes are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/google/cloud/dns/change/list.rb', line 135 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 ⇒ Change::List
Retrieve the next page of changes.
75 76 77 78 79 |
# File 'lib/google/cloud/dns/change/list.rb', line 75 def next return nil unless next? ensure_zone! @zone.changes token: token, max: @max, order: @order end |
#next? ⇒ Boolean
Whether there a next page of changes.
54 55 56 |
# File 'lib/google/cloud/dns/change/list.rb', line 54 def next? !token.nil? end |