Class: Gcloud::Dns::Change::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/dns/change/list.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Returns a new instance of List.



31
32
33
 
# File 'lib/gcloud/dns/change/list.rb', line 31

def initialize arr = []
  super arr
end

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.



27
28
29
 
# File 'lib/gcloud/dns/change/list.rb', line 27

def token
  @token
end

Class Method Details

.from_gapi(gapi, zone, max = nil, order = nil) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/gcloud/dns/change/list.rb', line 152

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

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.

Examples:

Iterating each change by passing a block:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"
changes = zone.changes

changes.all do |change|
  puts change.name
end

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"
changes = zone.changes

all_names = changes.all.map do |change|
  change.name
end

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"
changes = zone.changes

changes.all(request_limit: 10) do |change|
  puts change.name
end

Parameters:

  • 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 Parameters:

  • change (Change) —

    The change object.

Returns:

  • (Enumerator) 


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/gcloud/dns/change/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 ⇒ Change::List

Retrieve the next page of changes.

Examples:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"

changes = zone.changes
if changes.next?
  next_changes = changes.next
end

Returns:



73
74
75
76
77
 
# File 'lib/gcloud/dns/change/list.rb', line 73

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.

Examples:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"

changes = zone.changes
if changes.next?
  next_changes = changes.next
end

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/gcloud/dns/change/list.rb', line 52

def next?
  !token.nil?
end