Class: Azure::Network::Mgmt::V2018_08_01::Models::RouteListResult

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb

Overview

Response for the ListRoute API service call

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

Returns The URL to get the next set of results.

Returns:

  • (String)

    The URL to get the next set of results.


20
21
22
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 20

def next_link
  @next_link
end

#next_methodObject

return [Proc] with next page method call.


23
24
25
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 23

def next_method
  @next_method
end

#valueArray<Route>

Returns Gets a list of routes in a resource group.

Returns:

  • (Array<Route>)

    Gets a list of routes in a resource group.


17
18
19
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 17

def value
  @value
end

Class Method Details

.mapperObject

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


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
91
92
93
94
95
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 58

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RouteListResult',
    type: {
      name: 'Composite',
      class_name: 'RouteListResult',
      model_properties: {
        value: {
          client_side_validation: true,
          required: false,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RouteElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Route'
                }
            }
          }
        },
        next_link: {
          client_side_validation: true,
          required: false,
          serialized_name: 'nextLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end

Instance Method Details

#get_all_itemsArray<Route>

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

Returns:

  • (Array<Route>)

    operation results.


30
31
32
33
34
35
36
37
38
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 30

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

#get_next_pageRouteListResult

Gets the next page of results.

Returns:


45
46
47
48
49
50
51
52
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/route_list_result.rb', line 45

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