Class: OCI::NetworkLoadBalancer::NetworkLoadBalancerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_load_balancer/network_load_balancer_client.rb

Overview

This describes the network load balancer API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NetworkLoadBalancerClient

Creates a new NetworkLoadBalancerClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20200501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "NetworkLoadBalancerClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_network_load_balancer_compartment(network_load_balancer_id, change_network_load_balancer_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_network_load_balancer_compartment API.

Moves a network load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 128

def change_network_load_balancer_compartment(network_load_balancer_id, change_network_load_balancer_compartment_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#change_network_load_balancer_compartment.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling change_network_load_balancer_compartment." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'change_network_load_balancer_compartment_details' when calling change_network_load_balancer_compartment." if change_network_load_balancer_compartment_details.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/actions/changeCompartment'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_network_load_balancer_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#change_network_load_balancer_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_backend(network_load_balancer_id, create_backend_details, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_backend API.

Adds a backend server to a backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • create_backend_details (OCI::NetworkLoadBalancer::Models::CreateBackendDetails) —

    The details to add a backend server to a backend set.

  • backend_set_name (String) —

    The name of the backend set to which to add the backend server.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 204

def create_backend(network_load_balancer_id, create_backend_details, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#create_backend.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling create_backend." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'create_backend_details' when calling create_backend." if create_backend_details.nil?
  raise "Missing the required parameter 'backend_set_name' when calling create_backend." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_backend_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#create_backend') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_backend_set(network_load_balancer_id, create_backend_set_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_backend_set API.

Adds a backend set to a network load balancer.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 278

def create_backend_set(network_load_balancer_id, create_backend_set_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#create_backend_set.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling create_backend_set." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'create_backend_set_details' when calling create_backend_set." if create_backend_set_details.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_backend_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#create_backend_set') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_listener(network_load_balancer_id, create_listener_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_listener API.

Adds a listener to a network load balancer.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 350

def create_listener(network_load_balancer_id, create_listener_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#create_listener.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling create_listener." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'create_listener_details' when calling create_listener." if create_listener_details.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/listeners'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_listener_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#create_listener') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_network_load_balancer(create_network_load_balancer_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_network_load_balancer API.

Creates a network load balancer.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 416

def create_network_load_balancer(create_network_load_balancer_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#create_network_load_balancer.' if logger

  raise "Missing the required parameter 'create_network_load_balancer_details' when calling create_network_load_balancer." if create_network_load_balancer_details.nil?

  path = '/networkLoadBalancers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_network_load_balancer_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#create_network_load_balancer') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_backend(network_load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_backend API.

Removes a backend server from a given network load balancer and backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set associated with the backend server.

    Example: example_backend_set

  • backend_name (String) —

    The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

    Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 490

def delete_backend(network_load_balancer_id, backend_set_name, backend_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#delete_backend.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling delete_backend." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling delete_backend." if backend_set_name.nil?
  raise "Missing the required parameter 'backend_name' when calling delete_backend." if backend_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)
  raise "Parameter value for 'backend_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s).sub('{backendName}', backend_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#delete_backend') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_backend_set(network_load_balancer_id, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_backend_set API.

Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the network load balancer.

Before you can delete a backend set, you must remove it from any active listeners.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set to delete.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 563

def delete_backend_set(network_load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#delete_backend_set.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling delete_backend_set." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling delete_backend_set." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#delete_backend_set') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_listener(network_load_balancer_id, listener_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_listener API.

Deletes a listener from a network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • listener_name (String) —

    The name of the listener to delete.

    Example: example_listener

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 631

def delete_listener(network_load_balancer_id, listener_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#delete_listener.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling delete_listener." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'listener_name' when calling delete_listener." if listener_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'listener_name' must not be blank" if OCI::Internal::Util.blank_string?(listener_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/listeners/{listenerName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{listenerName}', listener_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#delete_listener') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_network_load_balancer(network_load_balancer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_network_load_balancer API.

Deletes a network load balancer resource by identifier.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:

  • (Response) —

    A Response object with data of type nil



695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 695

def delete_network_load_balancer(network_load_balancer_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#delete_network_load_balancer.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling delete_network_load_balancer." if network_load_balancer_id.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#delete_network_load_balancer') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backend(network_load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_backend API.

Retrieves the configuration information for the specified backend server.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set that includes the backend server.

    Example: example_backend_set

  • backend_name (String) —

    The name of the backend server to retrieve. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

    Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

Returns:



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 768

def get_backend(network_load_balancer_id, backend_set_name, backend_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_backend.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_backend." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling get_backend." if backend_set_name.nil?
  raise "Missing the required parameter 'backend_name' when calling get_backend." if backend_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)
  raise "Parameter value for 'backend_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s).sub('{backendName}', backend_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_backend') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::Backend'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backend_health(network_load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_backend_health API.

Retrieves the current health status of the specified backend server.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set associated with the backend server for which to retrieve the health status.

    Example: example_backend_set

  • backend_name (String) —

    The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

    Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 840

def get_backend_health(network_load_balancer_id, backend_set_name, backend_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_backend_health.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_backend_health." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling get_backend_health." if backend_set_name.nil?
  raise "Missing the required parameter 'backend_name' when calling get_backend_health." if backend_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)
  raise "Parameter value for 'backend_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s).sub('{backendName}', backend_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_backend_health') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::BackendHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backend_set(network_load_balancer_id, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_backend_set API.

Retrieves the configuration information for the specified backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set to retrieve.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

Returns:



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 910

def get_backend_set(network_load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_backend_set.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_backend_set." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling get_backend_set." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_backend_set') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::BackendSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backend_set_health(network_load_balancer_id, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_backend_set_health API.

Retrieves the health status for the specified backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set for which to retrieve the health status.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 973

def get_backend_set_health(network_load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_backend_set_health.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_backend_set_health." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling get_backend_set_health." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/health'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_backend_set_health') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::BackendSetHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_health_checker(network_load_balancer_id, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_health_checker API.

Retrieves the health check policy information for a given network load balancer and backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set associated with the health check policy to be retrieved.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1047

def get_health_checker(network_load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_health_checker.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_health_checker." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling get_health_checker." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/healthChecker'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_health_checker') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::HealthChecker'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_listener(network_load_balancer_id, listener_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_listener API.

Retrieves listener properties associated with a given network load balancer and listener name.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • listener_name (String) —

    The name of the listener to get.

    Example: example_listener

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

Returns:



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1118

def get_listener(network_load_balancer_id, listener_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_listener.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_listener." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'listener_name' when calling get_listener." if listener_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'listener_name' must not be blank" if OCI::Internal::Util.blank_string?(listener_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/listeners/{listenerName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{listenerName}', listener_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_listener') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::Listener'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_load_balancer(network_load_balancer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_network_load_balancer API.

Retrieves network load balancer configuration information by identifier.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1183

def get_network_load_balancer(network_load_balancer_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_network_load_balancer.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_network_load_balancer." if network_load_balancer_id.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_network_load_balancer') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_load_balancer_health(network_load_balancer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_network_load_balancer_health API.

Retrieves the health status for the specified network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1240

def get_network_load_balancer_health(network_load_balancer_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_network_load_balancer_health.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling get_network_load_balancer_health." if network_load_balancer_id.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/health'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_network_load_balancer_health') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancerHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_work_request API.

Retrieves the details of the work request with the given identifier.

Parameters:

  • work_request_id (String) —

    The identifier of the asynchronous request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1296

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#get_work_request.' if logger

  raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#get_work_request') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backend_sets(network_load_balancer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_backend_sets API.

Lists all backend sets associated with a given network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1370

def list_backend_sets(network_load_balancer_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_backend_sets.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling list_backend_sets." if network_load_balancer_id.nil?

  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_backend_sets') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::BackendSetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backends(network_load_balancer_id, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_backends API.

Lists the backend servers for a given network load balancer and backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • backend_set_name (String) —

    The name of the backend set associated with the backend servers.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1461

def list_backends(network_load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_backends.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling list_backends." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling list_backends." if backend_set_name.nil?

  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_backends') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::BackendCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_listeners(network_load_balancer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_listeners API.

Lists all listeners associated with a given network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :if_none_match (String) —

    The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified).

    Example: example-etag (default to )

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1550

def list_listeners(network_load_balancer_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_listeners.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling list_listeners." if network_load_balancer_id.nil?

  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/listeners'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_listeners') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::ListenerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_load_balancer_healths(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_load_balancer_healths API.

Lists the summary health statuses for all network load balancers in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the network load balancers to list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1632

def list_network_load_balancer_healths(compartment_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancer_healths.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_network_load_balancer_healths." if compartment_id.nil?

  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/networkLoadBalancers/health'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_network_load_balancer_healths') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_load_balancers(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_load_balancers API.

Returns a list of network load balancers.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the network load balancers to list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1716

def list_network_load_balancers(compartment_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancers.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_network_load_balancers." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::NetworkLoadBalancer::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::NetworkLoadBalancer::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/networkLoadBalancers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_network_load_balancers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancerCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_load_balancers_policies(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_load_balancers_policies API.

Lists the available network load balancer policies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1801

def list_network_load_balancers_policies(opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancers_policies.' if logger


  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/networkLoadBalancersPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_network_load_balancers_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancersPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_load_balancers_protocols(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_load_balancers_protocols API.

This API has been deprecated so it won't return the updated list of supported protocls. Lists all supported traffic protocols.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName

Returns:



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1880

def list_network_load_balancers_protocols(opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancers_protocols.' if logger


  if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/networkLoadBalancersProtocols'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_network_load_balancers_protocols') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::NetworkLoadBalancersProtocolCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_errors API.

Return a (paginated) list of errors for a given work request.

Parameters:

  • work_request_id (String) —

    The identifier of the asynchronous request.

  • compartment_id (String) —

    The OCID of the compartment containing the network load balancers to list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

Returns:



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 1956

def list_work_request_errors(work_request_id, compartment_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_work_request_errors." if compartment_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_work_request_errors') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_request_logs API.

Returns a (paginated) list of logs for a given work request.

Parameters:

  • work_request_id (String) —

    The identifier of the asynchronous request.

  • compartment_id (String) —

    The OCID of the compartment containing the network load balancers to list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

Returns:



2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2026

def list_work_request_logs(work_request_id, compartment_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_work_request_logs." if compartment_id.nil?
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_work_request_logs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_work_requests API.

Lists all work requests.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the network load balancers to list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    The page token representing the page from which to start retrieving results. For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2094

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::NetworkLoadBalancer::Models::WorkRequestCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_backend(network_load_balancer_id, update_backend_details, backend_set_name, backend_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_backend API.

Updates the configuration of a backend server within the specified backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • update_backend_details (OCI::NetworkLoadBalancer::Models::UpdateBackendDetails) —

    Details for updating a backend server.

  • backend_set_name (String) —

    The name of the backend set associated with the backend server.

    Example: example_backend_set

  • backend_name (String) —

    The name of the backend server to update. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

    Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2176

def update_backend(network_load_balancer_id, update_backend_details, backend_set_name, backend_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_backend.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_backend." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_backend_details' when calling update_backend." if update_backend_details.nil?
  raise "Missing the required parameter 'backend_set_name' when calling update_backend." if backend_set_name.nil?
  raise "Missing the required parameter 'backend_name' when calling update_backend." if backend_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)
  raise "Parameter value for 'backend_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s).sub('{backendName}', backend_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_backend_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_backend') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_backend_set(network_load_balancer_id, update_backend_set_details, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_backend_set API.

Updates a backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • update_backend_set_details (OCI::NetworkLoadBalancer::Models::UpdateBackendSetDetails) —

    The details to update a backend set.

  • backend_set_name (String) —

    The name of the backend set to update.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2256

def update_backend_set(network_load_balancer_id, update_backend_set_details, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_backend_set.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_backend_set." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_backend_set_details' when calling update_backend_set." if update_backend_set_details.nil?
  raise "Missing the required parameter 'backend_set_name' when calling update_backend_set." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_backend_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_backend_set') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_health_checker(network_load_balancer_id, update_health_checker_details, backend_set_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_health_checker API.

Updates the health check policy for a given network load balancer and backend set.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • update_health_checker_details (OCI::NetworkLoadBalancer::Models::UpdateHealthCheckerDetails) —

    The health check policy configuration details.

  • backend_set_name (String) —

    The name of the backend set associated with the health check policy to be retrieved.

    Example: example_backend_set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2334

def update_health_checker(network_load_balancer_id, update_health_checker_details, backend_set_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_health_checker.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_health_checker." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_health_checker_details' when calling update_health_checker." if update_health_checker_details.nil?
  raise "Missing the required parameter 'backend_set_name' when calling update_health_checker." if backend_set_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/healthChecker'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{backendSetName}', backend_set_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_health_checker_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_health_checker') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_listener(network_load_balancer_id, update_listener_details, listener_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_listener API.

Updates a listener for a given network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • update_listener_details (OCI::NetworkLoadBalancer::Models::UpdateListenerDetails) —

    Details to update a listener.

  • listener_name (String) —

    The name of the listener to update.

    Example: example_listener

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2412

def update_listener(network_load_balancer_id, update_listener_details, listener_name, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_listener.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_listener." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_listener_details' when calling update_listener." if update_listener_details.nil?
  raise "Missing the required parameter 'listener_name' when calling update_listener." if listener_name.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
  raise "Parameter value for 'listener_name' must not be blank" if OCI::Internal::Util.blank_string?(listener_name)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/listeners/{listenerName}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s).sub('{listenerName}', listener_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_listener_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_listener') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_network_load_balancer(network_load_balancer_id, update_network_load_balancer_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_network_load_balancer API.

Updates the network load balancer

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Returns:

  • (Response) —

    A Response object with data of type nil



2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2480

def update_network_load_balancer(network_load_balancer_id, update_network_load_balancer_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_network_load_balancer.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_network_load_balancer." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_network_load_balancer_details' when calling update_network_load_balancer." if update_network_load_balancer_details.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_network_load_balancer_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_network_load_balancer') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_network_security_groups(network_load_balancer_id, update_network_security_groups_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_network_security_groups API.

Updates the network security groups associated with the specified network load balancer.

Parameters:

  • network_load_balancer_id (String) —

    The OCID of the network load balancer to update.

  • update_network_security_groups_details (OCI::NetworkLoadBalancer::Models::UpdateNetworkSecurityGroupsDetails) —

    The details for updating the network security groups associated with the specified network load balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource. (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
 
# File 'lib/oci/network_load_balancer/network_load_balancer_client.rb', line 2550

def update_network_security_groups(network_load_balancer_id, update_network_security_groups_details, opts = {})
  logger.debug 'Calling operation NetworkLoadBalancerClient#update_network_security_groups.' if logger

  raise "Missing the required parameter 'network_load_balancer_id' when calling update_network_security_groups." if network_load_balancer_id.nil?
  raise "Missing the required parameter 'update_network_security_groups_details' when calling update_network_security_groups." if update_network_security_groups_details.nil?
  raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)

  path = '/networkLoadBalancers/{networkLoadBalancerId}/networkSecurityGroups'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_network_security_groups_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#update_network_security_groups') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end