Class: Azure::Network::Mgmt::V2018_08_01::Models::ListVpnConnectionsResult

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

Overview

Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

there are any.

Returns:

  • (String)

    URL to get the next set of operation list results if


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

def next_link
  @next_link
end

#next_methodObject

return [Proc] with next page method call.


26
27
28
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/list_vpn_connections_result.rb', line 26

def next_method
  @next_method
end

#valueArray<VpnConnection>

Returns List of Vpn Connections.

Returns:


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

def value
  @value
end

Class Method Details

.mapperObject

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


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
96
97
98
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/list_vpn_connections_result.rb', line 61

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

Instance Method Details

#get_all_itemsArray<VpnConnection>

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

Returns:


33
34
35
36
37
38
39
40
41
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/list_vpn_connections_result.rb', line 33

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_pageListVpnConnectionsResult

Gets the next page of results.

Returns:


48
49
50
51
52
53
54
55
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/list_vpn_connections_result.rb', line 48

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