class Google::Cloud::Dns::Change::List
Change::List
is a special case Array with additional values.
Attributes
If not empty, indicates that there are more changes that match the request and this value should be passed to continue.
Public Class Methods
@private New Changes::List from a response object.
# File lib/google/cloud/dns/change/list.rb, line 149 def self.from_gapi gapi, zone, max = nil, order = nil changes = new(Array(gapi.changes).map do |g| Change.from_gapi g, zone end) changes.instance_variable_set :@token, gapi.next_page_token changes.instance_variable_set :@zone, zone changes.instance_variable_set :@max, max changes.instance_variable_set :@order, order changes end
@private Create a new Change::List
with an array of Change
instances.
# File lib/google/cloud/dns/change/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 changes. Default is no limit.
@yield [change] The block for accessing each change. @yieldparam [Change] change The change object.
@return [Enumerator]
@example Iterating each change by passing a block:
require "google/cloud/dns" dns = Google::Cloud::Dns.new zone = dns.zone "example-com" changes = zone.changes changes.all do |change| puts change.id end
@example Using the enumerator by not passing a block:
require "google/cloud/dns" dns = Google::Cloud::Dns.new zone = dns.zone "example-com" changes = zone.changes all_names = changes.all.map do |change| change.id end
@example Limit the number of API calls made:
require "google/cloud/dns" dns = Google::Cloud::Dns.new zone = dns.zone "example-com" changes = zone.changes changes.all(request_limit: 10) do |change| puts change.id end
# File lib/google/cloud/dns/change/list.rb, line 130 def all request_limit: nil, &block 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(&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 changes.
@return [Change::List]
@example
require "google/cloud/dns" dns = Google::Cloud::Dns.new zone = dns.zone "example-com" changes = zone.changes if changes.next? next_changes = changes.next end
# File lib/google/cloud/dns/change/list.rb, line 73 def next return nil unless next? ensure_zone! @zone.changes token: token, max: @max, order: @order end
Whether there a next page of changes.
@return [Boolean]
@example
require "google/cloud/dns" dns = Google::Cloud::Dns.new zone = dns.zone "example-com" changes = zone.changes if changes.next? next_changes = changes.next end
# File lib/google/cloud/dns/change/list.rb, line 53 def next? !token.nil? end
Protected Instance Methods
Raise an error unless an active connection is available.
# File lib/google/cloud/dns/change/list.rb, line 164 def ensure_zone! raise "Must have active connection" unless @zone end