Class: Gcloud::Dns::Zone::List

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

Overview

Zone::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/zone/list.rb', line 31

def initialize arr = []
  super arr
end

Instance Attribute Details

#token ⇒ Object

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



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

def token
  @token
end

Class Method Details

.from_gapi(gapi, conn, max = nil) ⇒ Object 



148
149
150
151
152
153
154
155
156
 
# File 'lib/gcloud/dns/zone/list.rb', line 148

def self.from_gapi gapi, conn, max = nil
  zones = new(Array(gapi.managed_zones).map do |g|
    Zone.from_gapi g, conn
  end)
  zones.instance_variable_set "@token",   gapi.next_page_token
  zones.instance_variable_set "@service", conn
  zones.instance_variable_set "@max",     max
  zones
end

Instance Method Details

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

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

An Enumerator is returned if no block is given.

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

Examples:

Iterating each zone by passing a block:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zones = dns.zones

zones.all do |zone|
  puts zone.name
end

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zones = dns.zones

all_names = zones.all.map do |zone|
  zone.name
end

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zones = dns.zones

zones.all(request_limit: 10) do |zone|
  puts zone.name
end

Parameters:

  • request_limit (Integer) (defaults to: nil) —

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

Yields:

  • (zone) —

    The block for accessing each zone.

Yield Parameters:

  • zone (Zone) —

    The zone object.

Returns:

  • (Enumerator) 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/gcloud/dns/zone/list.rb', line 129

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

Retrieve the next page of zones.

Examples:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns

zones = dns.zones
if zones.next?
  next_zones = zones.next
end

Returns:



71
72
73
74
75
76
 
# File 'lib/gcloud/dns/zone/list.rb', line 71

def next
  return nil unless next?
  ensure_service!
  gapi = @service.list_zones token: token, max: @max
  Zone::List.from_gapi gapi, @service, @max
end

#next? ⇒ Boolean

Whether there a next page of zones.

Examples:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns

zones = dns.zones
if zones.next?
  next_zones = zones.next
end

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/gcloud/dns/zone/list.rb', line 51

def next?
  !token.nil?
end