Cloud DNS API - Class Google::Cloud::Dns::Change::List (v0.36.1)

Reference documentation and code samples for the Cloud DNS API class Google::Cloud::Dns::Change::List.

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |change| ... } -> Enumerator

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.

Parameter
  • request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all changes. Default is no limit.
Yields
  • (change) — The block for accessing each change.
Yield Parameter
  • change (Change) — The change object.
Returns
  • (Enumerator)
Examples

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

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

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

#next

def next() -> Change::List

Retrieve the next page of changes.

Returns
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

#next?

def next?() -> Boolean

Whether there a next page of changes.

Returns
  • (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

#token

def token()

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

#token=

def token=(value)

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