Class: Azure::ARM::Dns::Models::ZoneListResult

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_dns/models/zone_list_result.rb

Overview

The response to a Zone List or ListAll operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

Returns The continuation token for the next page of results.

Returns:

  • (String) —

    The continuation token for the next page of results.



19
20
21
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 19

def next_link
  @next_link
end

#next_method ⇒ Object

return [Proc] with next page method call.



22
23
24
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 22

def next_method
  @next_method
end

#value ⇒ Array<Zone>

Returns Information about the DNS zones.

Returns:

  • (Array<Zone>) —

    Information about the DNS zones.



16
17
18
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 16

def value
  @value
end

Class Method Details

.mapper ⇒ Object

Mapper for ZoneListResult class as Ruby Hash. This will be used for serialization/deserialization.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 57

def self.mapper()
  {
    required: false,
    serialized_name: 'ZoneListResult',
    type: {
      name: 'Composite',
      class_name: 'ZoneListResult',
      model_properties: {
        value: {
          required: false,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'ZoneElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Zone'
                }
            }
          }
        },
        next_link: {
          required: false,
          serialized_name: 'nextLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end

Instance Method Details

#get_all_items ⇒ Array<Zone>

Gets the rest of the items for the request, enabling auto-pagination.

Returns:

  • (Array<Zone>) —

    operation results.



29
30
31
32
33
34
35
36
37
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 29

def get_all_items
  items = @value
  page = self
  while page.next_link != nil do
    page = page.get_next_page
    items.concat(page.value)
  end
  items
end

#get_next_page ⇒ ZoneListResult

Gets the next page of results.

Returns:



44
45
46
47
48
49
50
51
 
# File 'lib/generated/azure_mgmt_dns/models/zone_list_result.rb', line 44

def get_next_page
  response = @next_method.call(@next_link).value! unless @next_method.nil?
  unless response.nil?
    @next_link = response.body.next_link
    @value = response.body.value
    self
  end
end