Class: Azure::Peering::Mgmt::V2019_08_01_preview::PeeringLocations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb

Overview

Peering Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PeeringLocations

Creates and initializes a new instance of the PeeringLocations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ PeeringClient (readonly)

Returns reference to the PeeringClient.

Returns:



22
23
24
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 22

def client
  @client
end

Instance Method Details

#list(kind, direct_peering_type: nil, custom_headers: nil) ⇒ Array<PeeringLocation>

Lists all of the available peering locations for the specified kind of peering.

‘Direct’, ‘Exchange’ include: ‘Edge’, ‘Transit’, ‘Cdn’, ‘Internal’ will be added to the HTTP request.

Parameters:

  • kind (Enum) —

    The kind of the peering. Possible values include:

  • direct_peering_type (Enum) (defaults to: nil) —

    The type of direct peering. Possible values

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<PeeringLocation>) —

    operation results.



37
38
39
40
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 37

def list(kind, direct_peering_type:nil, custom_headers:nil)
  first_page = list_as_lazy(kind, direct_peering_type:direct_peering_type, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(kind, direct_peering_type: nil, custom_headers: nil) ⇒ PeeringLocationListResult

Lists all of the available peering locations for the specified kind of peering.

‘Direct’, ‘Exchange’ include: ‘Edge’, ‘Transit’, ‘Cdn’, ‘Internal’ will be added to the HTTP request.

response.

Parameters:

  • kind (Enum) —

    The kind of the peering. Possible values include:

  • direct_peering_type (Enum) (defaults to: nil) —

    The type of direct peering. Possible values

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (PeeringLocationListResult) —

    which provide lazy access to pages of the



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 233

def list_as_lazy(kind, direct_peering_type:nil, custom_headers:nil)
  response = list_async(kind, direct_peering_type:direct_peering_type, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(kind, direct_peering_type: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the available peering locations for the specified kind of peering.

‘Direct’, ‘Exchange’ include: ‘Edge’, ‘Transit’, ‘Cdn’, ‘Internal’ to the HTTP request.

Parameters:

  • kind (Enum) —

    The kind of the peering. Possible values include:

  • direct_peering_type (Enum) (defaults to: nil) —

    The type of direct peering. Possible values

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 72

def list_async(kind, direct_peering_type:nil, custom_headers:nil)
  fail ArgumentError, 'kind is nil' if kind.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringLocations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'kind' => kind,'directPeeringType' => direct_peering_type,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Peering::Mgmt::V2019_08_01_preview::Models::PeeringLocationListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ PeeringLocationListResult

Lists all of the available peering locations for the specified kind of peering.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (PeeringLocationListResult) —

    operation results.



137
138
139
140
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 137

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the available peering locations for the specified kind of peering.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 168

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Peering::Mgmt::V2019_08_01_preview::Models::PeeringLocationListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available peering locations for the specified kind of peering.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



153
154
155
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 153

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(kind, direct_peering_type: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available peering locations for the specified kind of peering.

‘Direct’, ‘Exchange’ include: ‘Edge’, ‘Transit’, ‘Cdn’, ‘Internal’ will be added to the HTTP request.

Parameters:

  • kind (Enum) —

    The kind of the peering. Possible values include:

  • direct_peering_type (Enum) (defaults to: nil) —

    The type of direct peering. Possible values

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_locations.rb', line 55

def list_with_http_info(kind, direct_peering_type:nil, custom_headers:nil)
  list_async(kind, direct_peering_type:direct_peering_type, custom_headers:custom_headers).value!
end