Class: Gcloud::Dns::Record::List

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Create a new Record::List with an array of Record instances.


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

def initialize arr = []
  super arr
end

Instance Attribute Details

#tokenObject

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


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

def token
  @token
end

Instance Method Details

#allObject

Retrieves all records by repeatedly loading pages until #next? returns false. Returns the list instance for method chaining.

Examples:

require "gcloud"

gcloud = Gcloud.new
dns = gcloud.dns
zone = dns.zone "example-com"
records = zone.records.all # Load all pages of records

61
62
63
64
65
66
67
68
# File 'lib/gcloud/dns/record/list.rb', line 61

def all
  while next?
    next_records = self.next
    push(*next_records)
    self.token = next_records.token
  end
  self
end

#nextObject

Retrieve the next page of records.


43
44
45
46
47
# File 'lib/gcloud/dns/record/list.rb', line 43

def next
  return nil unless next?
  ensure_zone!
  @zone.records token: token
end

#next?Boolean

Whether there a next page of records.

Returns:

  • (Boolean)

37
38
39
# File 'lib/gcloud/dns/record/list.rb', line 37

def next?
  !token.nil?
end