Cloud DNS API - Class Google::Cloud::Dns::Zone::List (v1.1.0)

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

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

Inherits

  • Array

Methods

#all

  def 
  
 all 
 ( 
 request_limit 
 : 
  
 nil 
 , 
  
& block 
 ) 
  
 { 
  
 | 
 zone 
 | 
  
 ... 
  
 } 
  
 - 
>  
 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 zones. Default is no limit.
Yields
  • (zone) — The block for accessing each zone.
Yield Parameter
  • zone( Zone ) — The zone object.
Returns
  • (Enumerator)
Examples

Iterating each zone by passing a block:

 require 
  
 "google/cloud/dns" 
 dns 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Dns 
 . 
 new 
 zones 
  
 = 
  
 dns 
 . 
 zones 
 zones 
 . 
 all 
  
 do 
  
 | 
 zone 
 | 
  
 puts 
  
 zone 
 . 
 name 
 end 

Using the enumerator by not passing a block:

 require 
  
 "google/cloud/dns" 
 dns 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Dns 
 . 
 new 
 zones 
  
 = 
  
 dns 
 . 
 zones 
 all_names 
  
 = 
  
 zones 
 . 
 all 
 . 
 map 
  
 do 
  
 | 
 zone 
 | 
  
 zone 
 . 
 name 
 end 

Limit the number of API calls made:

 require 
  
 "google/cloud/dns" 
 dns 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Dns 
 . 
 new 
 zones 
  
 = 
  
 dns 
 . 
 zones 
 zones 
 . 
 all 
 ( 
 request_limit 
 : 
  
 10 
 ) 
  
 do 
  
 | 
 zone 
 | 
  
 puts 
  
 zone 
 . 
 name 
 end 

#next

  def 
  
 next 
 () 
  
 - 
>  
 Zone 
 :: 
 List 
 

Retrieve the next page of zones.

Returns
Example
 require 
  
 "google/cloud/dns" 
 dns 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Dns 
 . 
 new 
 zones 
  
 = 
  
 dns 
 . 
 zones 
 if 
  
 zones 
 . 
 next? 
  
 next_zones 
  
 = 
  
 zones 
 . 
 next 
 end 

#next?

  def 
  
 next? 
 () 
  
 - 
>  
 Boolean 
 

Whether there a next page of zones.

Returns
  • (Boolean)
Example
 require 
  
 "google/cloud/dns" 
 dns 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Dns 
 . 
 new 
 zones 
  
 = 
  
 dns 
 . 
 zones 
 if 
  
 zones 
 . 
 next? 
  
 next_zones 
  
 = 
  
 zones 
 . 
 next 
 end 

#token

  def 
  
 token 
 () 
 

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

#token=

  def 
  
 token= 
 ( 
 value 
 ) 
 

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

Design a Mobile Site
View Site in Mobile | Classic
Share by: