Class: OCI::LoadBalancer::LoadBalancerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/load_balancer_client.rb

Overview

API for the Load Balancing service. Use this API to manage load balancers, backend sets, and related items. For more information, see Overview of Load Balancing.

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) ⇒ LoadBalancerClient

Creates a new LoadBalancerClient. 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



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

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 + '/20170115'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "LoadBalancerClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 30

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:



26
27
28
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#change_load_balancer_compartment(load_balancer_id, change_load_balancer_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



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
168
169
170
171
172
173
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 134

def change_load_balancer_compartment(load_balancer_id, change_load_balancer_compartment_details, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#change_load_balancer_compartment.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/changeCompartment'.sub('{loadBalancerId}', 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_load_balancer_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#change_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(create_backend_details, load_balancer_id, 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:

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

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

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set and servers.

  • backend_set_name (String) —

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

    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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 215

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

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

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends'.sub('{loadBalancerId}', 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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # 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: 'LoadBalancerClient#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(create_backend_set_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Adds a backend set to a load balancer.

Parameters:

  • create_backend_set_details (OCI::LoadBalancer::Models::CreateBackendSetDetails) —

    The details for adding a backend set.

  • load_balancer_id (String) —

    The OCID of the load balancer on which to add a 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 294

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

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

  path = '/loadBalancers/{loadBalancerId}/backendSets'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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_certificate(create_certificate_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Creates an asynchronous request to add an SSL certificate bundle.

Parameters:

  • create_certificate_details (OCI::LoadBalancer::Models::CreateCertificateDetails) —

    The details of the certificate bundle to add.

  • load_balancer_id (String) —

    The OCID of the load balancer on which to add the certificate bundle.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 371

def create_certificate(create_certificate_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_certificate.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/certificates'.sub('{loadBalancerId}', 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_certificate_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_certificate') 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_hostname(create_hostname_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Adds a hostname resource to the specified load balancer. For more information, see Managing Request Routing.

Parameters:

  • create_hostname_details (OCI::LoadBalancer::Models::CreateHostnameDetails) —

    The details of the hostname resource to add to the specified load balancer.

  • load_balancer_id (String) —

    The OCID of the load balancer to add the hostname to.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 450

def create_hostname(create_hostname_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_hostname.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/hostnames'.sub('{loadBalancerId}', 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_hostname_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_hostname') 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(create_listener_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Adds a listener to a 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 527

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

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

  path = '/loadBalancers/{loadBalancerId}/listeners'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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_load_balancer(create_load_balancer_details, opts = {}) ⇒ Response

Note:

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

Creates a new load balancer in the specified compartment. For general information about load balancers, see Overview of the Load Balancing Service.

For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see Overview of the IAM Service.

You must specify a display name for the load balancer. It does not have to be unique, and you can change it.

For information about Availability Domains, see Regions and Availability Domains. To get a list of Availability Domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers.

After you send your request, the new object's state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING.

When you create a load balancer, the system assigns an IP address. To get the IP address, use the get_load_balancer operation.

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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



619
620
621
622
623
624
625
626
627
628
629
630
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
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 619

def create_load_balancer(create_load_balancer_details, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_load_balancer.' if logger

  raise "Missing the required parameter 'create_load_balancer_details' when calling create_load_balancer." if create_load_balancer_details.nil?

  path = '/loadBalancers'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_load_balancer_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_path_route_set(create_path_route_set_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Adds a path route set to a load balancer. For more information, see Managing Request Routing.

Parameters:

  • create_path_route_set_details (OCI::LoadBalancer::Models::CreatePathRouteSetDetails) —

    The details of the path route set to add.

  • load_balancer_id (String) —

    The OCID of the load balancer to add the path route set to.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

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
732
733
734
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 695

def create_path_route_set(create_path_route_set_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_path_route_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/pathRouteSets'.sub('{loadBalancerId}', 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_path_route_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_path_route_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_routing_policy(create_routing_policy_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Adds a routing policy to a load balancer. For more information, see Managing Request Routing.

Parameters:

  • create_routing_policy_details (OCI::LoadBalancer::Models::CreateRoutingPolicyDetails) —

    The details of the routing policy rules to add.

  • load_balancer_id (String) —

    The OCID of the load balancer to add the routing policy rule list to.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



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
810
811
812
813
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 774

def create_routing_policy(create_routing_policy_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_routing_policy.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/routingPolicies'.sub('{loadBalancerId}', 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_routing_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_routing_policy') 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_rule_set(load_balancer_id, create_rule_set_details, opts = {}) ⇒ Response

Note:

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

Creates a new rule set associated with the specified load balancer. For more information, see Managing Rule Sets.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • create_rule_set_details (OCI::LoadBalancer::Models::CreateRuleSetDetails) —

    The configuration details for the rule set to create.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



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
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 853

def create_rule_set(load_balancer_id, create_rule_set_details, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_rule_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/ruleSets'.sub('{loadBalancerId}', 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_rule_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_rule_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_ssl_cipher_suite(create_ssl_cipher_suite_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Creates a custom SSL cipher suite.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 931

def create_ssl_cipher_suite(create_ssl_cipher_suite_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#create_ssl_cipher_suite.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/sslCipherSuites'.sub('{loadBalancerId}', 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_ssl_cipher_suite_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#create_ssl_cipher_suite') 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

#delete_backend(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 load balancer and backend set.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set and server.

  • backend_set_name (String) —

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

    Example: example_backend_set

  • backend_name (String) —

    The IP address and port of the backend server to remove.

    Example: 10.0.0.3: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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1009

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

  raise "Missing the required parameter 'load_balancer_id' when calling delete_backend." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(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 = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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(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 load balancer.

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

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1087

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

  raise "Missing the required parameter 'load_balancer_id' when calling delete_backend_set." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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_certificate(load_balancer_id, certificate_name, opts = {}) ⇒ Response

Note:

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

Deletes an SSL certificate bundle from a load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the certificate bundle to be deleted.

  • certificate_name (String) —

    The name of the certificate bundle to delete.

    Example: example_certificate_bundle

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1162

def delete_certificate(load_balancer_id, certificate_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_certificate.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/certificates/{certificateName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{certificateName}', certificate_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: 'LoadBalancerClient#delete_certificate') 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_hostname(load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Deletes a hostname resource from the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the hostname to delete.

  • name (String) —

    The name of the hostname resource to delete.

    Example: example_hostname_001

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1236
1237
1238
1239
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
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1236

def delete_hostname(load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_hostname.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/hostnames/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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: 'LoadBalancerClient#delete_hostname') 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(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 load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the listener to delete.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1309

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

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

  path = '/loadBalancers/{loadBalancerId}/listeners/{listenerName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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_load_balancer(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Stops a load balancer and removes it from service.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer to delete.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1378

def delete_load_balancer(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_load_balancer.' if logger

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

  path = '/loadBalancers/{loadBalancerId}'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#delete_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

#delete_path_route_set(load_balancer_id, path_route_set_name, opts = {}) ⇒ Response

Note:

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

Deletes a path route set from the specified load balancer.

To delete a path route rule from a path route set, use the update_path_route_set operation.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the path route set to delete.

  • path_route_set_name (String) —

    The name of the path route set to delete.

    Example: example_path_route_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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1453
1454
1455
1456
1457
1458
1459
1460
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
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1453

def delete_path_route_set(load_balancer_id, path_route_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_path_route_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{pathRouteSetName}', path_route_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: 'LoadBalancerClient#delete_path_route_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_routing_policy(load_balancer_id, routing_policy_name, opts = {}) ⇒ Response

Note:

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

Deletes a routing policy from the specified load balancer.

To delete a routing rule from a routing policy, use the update_routing_policy operation.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the routing policy to delete.

  • routing_policy_name (String) —

    The name of the routing policy to delete.

    Example: example_routing_policy

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1530

def delete_routing_policy(load_balancer_id, routing_policy_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_routing_policy.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{routingPolicyName}', routing_policy_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: 'LoadBalancerClient#delete_routing_policy') 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_rule_set(load_balancer_id, rule_set_name, opts = {}) ⇒ Response

Note:

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

Deletes a rule set from the specified load balancer.

To delete a rule from a rule set, use the update_rule_set operation.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • rule_set_name (String) —

    The name of the rule set to delete.

    Example: example_rule_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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1607

def delete_rule_set(load_balancer_id, rule_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_rule_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{ruleSetName}', rule_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: 'LoadBalancerClient#delete_rule_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_ssl_cipher_suite(load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Deletes an SSL cipher suite from a load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the associated load balancer.

  • name (String) —

    The name of the SSL cipher suite to delete.

    example: example_cipher_suite

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1681

def delete_ssl_cipher_suite(load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#delete_ssl_cipher_suite.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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: 'LoadBalancerClient#delete_ssl_cipher_suite') 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(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response

Note:

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

Gets the specified backend server's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set and server.

  • backend_set_name (String) —

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

    Example: example_backend_set

  • backend_name (String) —

    The IP address and port of the backend server to retrieve.

    Example: 10.0.0.3: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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1758

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

  raise "Missing the required parameter 'load_balancer_id' when calling get_backend." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(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 = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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::LoadBalancer::Models::Backend'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_backend_health(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.

Gets the current health status of the specified backend server.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend server health status to be retrieved.

  • backend_set_name (String) —

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

    Example: example_backend_set

  • backend_name (String) —

    The IP address and port of the backend server to retrieve the health status for.

    Example: 10.0.0.3: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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1838

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

  raise "Missing the required parameter 'load_balancer_id' when calling get_backend_health." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(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 = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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::LoadBalancer::Models::BackendHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets the specified backend set's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1914

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

  raise "Missing the required parameter 'load_balancer_id' when calling get_backend_set." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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::LoadBalancer::Models::BackendSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets the health status for the specified backend set.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set health status to be retrieved.

  • backend_set_name (String) —

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

    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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1988

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

  raise "Missing the required parameter 'load_balancer_id' when calling get_backend_set_health." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/health'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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::LoadBalancer::Models::BackendSetHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

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

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the health check policy to be retrieved.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2062

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

  raise "Missing the required parameter 'load_balancer_id' when calling get_health_checker." if 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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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::LoadBalancer::Models::HealthChecker'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hostname(load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Gets the specified hostname resource's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • name (String) —

    The name of the hostname resource to retrieve.

    Example: example_hostname_001

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2136

def get_hostname(load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_hostname.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/hostnames/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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: 'LoadBalancerClient#get_hostname') 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::LoadBalancer::Models::Hostname'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_load_balancer(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Gets the specified load balancer's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2206

def get_load_balancer(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_load_balancer.' if logger

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

  path = '/loadBalancers/{loadBalancerId}'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#get_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::LoadBalancer::Models::LoadBalancer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_load_balancer_health(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Gets the health status for the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer to return health status for.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2274

def get_load_balancer_health(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_load_balancer_health.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/health'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#get_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::LoadBalancer::Models::LoadBalancerHealth'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_path_route_set(load_balancer_id, path_route_set_name, opts = {}) ⇒ Response

Note:

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

Gets the specified path route set's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • path_route_set_name (String) —

    The name of the path route set to retrieve.

    Example: example_path_route_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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



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
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2346

def get_path_route_set(load_balancer_id, path_route_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_path_route_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{pathRouteSetName}', path_route_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: 'LoadBalancerClient#get_path_route_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::LoadBalancer::Models::PathRouteSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_routing_policy(load_balancer_id, routing_policy_name, opts = {}) ⇒ Response

Note:

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

Gets the specified routing policy.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • routing_policy_name (String) —

    The name of the routing policy to retrieve.

    Example: example_routing_policy

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



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
2454
2455
2456
2457
2458
2459
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2420

def get_routing_policy(load_balancer_id, routing_policy_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_routing_policy.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{routingPolicyName}', routing_policy_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: 'LoadBalancerClient#get_routing_policy') 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::LoadBalancer::Models::RoutingPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_rule_set(load_balancer_id, rule_set_name, opts = {}) ⇒ Response

Note:

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

Gets the specified set of rules.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • rule_set_name (String) —

    The name of the rule set to retrieve.

    Example: example_rule_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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2494

def get_rule_set(load_balancer_id, rule_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_rule_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{ruleSetName}', rule_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: 'LoadBalancerClient#get_rule_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::LoadBalancer::Models::RuleSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ssl_cipher_suite(load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Gets the specified SSL cipher suite's configuration information.

Parameters:

  • load_balancer_id (String) —

    The OCID of the associated load balancer.

  • name (String) —

    The name of the SSL cipher suite to retrieve.

    example: example_cipher_suite

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2569

def get_ssl_cipher_suite(load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#get_ssl_cipher_suite.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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: 'LoadBalancerClient#get_ssl_cipher_suite') 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::LoadBalancer::Models::SSLCipherSuite'
    )
  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.

Gets the details of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

Returns:



2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2628

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#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 = '/loadBalancerWorkRequests/{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: 'LoadBalancerClient#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::LoadBalancer::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backend_sets(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 load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend sets to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2695

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

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

  path = '/loadBalancers/{loadBalancerId}/backendSets'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#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: 'Array<OCI::LoadBalancer::Models::BackendSet>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_backends(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 load balancer and backend set.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set and servers.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2767

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

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

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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: 'Array<OCI::LoadBalancer::Models::Backend>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_certificates(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all SSL certificates bundles associated with a given load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the certificate bundles to be listed.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2839

def list_certificates(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_certificates.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/certificates'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#list_certificates') 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: 'Array<OCI::LoadBalancer::Models::Certificate>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hostnames(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all hostname resources associated with the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the hostnames to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2909

def list_hostnames(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_hostnames.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/hostnames'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#list_hostnames') 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: 'Array<OCI::LoadBalancer::Models::Hostname>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_listener_rules(load_balancer_id, listener_name, opts = {}) ⇒ Response

Note:

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

Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order:

  • Access control rules

  • Allow method rules

  • Request header rules

  • Response header rules

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the listener.

  • listener_name (String) —

    The name of the listener the rules are associated with.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2986

def list_listener_rules(load_balancer_id, listener_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_listener_rules.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/listeners/{listenerName}/rules'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#list_listener_rules') 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: 'Array<OCI::LoadBalancer::Models::ListenerRuleSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

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

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the load balancers to return health status information for.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 10)

  • :page (String) —

    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.

    Example: 3

Returns:



3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3055

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

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

  path = '/loadBalancerHealths'
  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: 'LoadBalancerClient#list_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: 'Array<OCI::LoadBalancer::Models::LoadBalancerHealthSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all load balancers in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 10)

  • :page (String) —

    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.

    Example: 3

  • :detail (String) —

    The level of detail to return for each result. Can be full or simple.

    Example: full (default to full)

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: ASC, DESC

  • :display_name (String) —

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

    Example: example_load_balancer

  • :lifecycle_state (String) —

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

    Example: SUCCEEDED

Returns:



3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3142

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

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

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

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

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

  path = '/loadBalancers'
  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]
  query_params[:detail] = opts[:detail] if opts[:detail]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # 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: 'LoadBalancerClient#list_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: 'Array<OCI::LoadBalancer::Models::LoadBalancer>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_path_route_sets(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all path route sets associated with the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the path route sets to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3230

def list_path_route_sets(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_path_route_sets.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/pathRouteSets'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#list_path_route_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: 'Array<OCI::LoadBalancer::Models::PathRouteSet>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the available load balancer policies.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the load balancer policies 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 16)

  • :page (String) —

    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.

    Example: 3

Returns:



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3297

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

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

  path = '/loadBalancerPolicies'
  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: 'LoadBalancerClient#list_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: 'Array<OCI::LoadBalancer::Models::LoadBalancerPolicy>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all supported traffic protocols.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the load balancer protocols 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 16)

  • :page (String) —

    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.

    Example: 3

Returns:



3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3365

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

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

  path = '/loadBalancerProtocols'
  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: 'LoadBalancerClient#list_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: 'Array<OCI::LoadBalancer::Models::LoadBalancerProtocol>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_routing_policies(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all routing policies associated with the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the routing policies.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 10)

  • :page (String) —

    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.

    Example: 3

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3445

def list_routing_policies(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_routing_policies.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/routingPolicies'.sub('{loadBalancerId}', 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]

  # 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: 'LoadBalancerClient#list_routing_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: 'Array<OCI::LoadBalancer::Models::RoutingPolicy>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_rule_sets(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all rule sets associated with the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3515

def list_rule_sets(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_rule_sets.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/ruleSets'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#list_rule_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: 'Array<OCI::LoadBalancer::Models::RuleSet>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the valid load balancer shapes.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment containing the load balancer shapes 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 16)

  • :page (String) —

    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.

    Example: 3

Returns:



3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3582

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

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

  path = '/loadBalancerShapes'
  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: 'LoadBalancerClient#list_shapes') 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: 'Array<OCI::LoadBalancer::Models::LoadBalancerShape>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ssl_cipher_suites(load_balancer_id, opts = {}) ⇒ Response

Note:

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

Lists all SSL cipher suites associated with the specified load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the associated 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3652

def list_ssl_cipher_suites(load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#list_ssl_cipher_suites.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/sslCipherSuites'.sub('{loadBalancerId}', 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[:'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: 'LoadBalancerClient#list_ssl_cipher_suites') 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: 'Array<OCI::LoadBalancer::Models::SSLCipherSuite>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the work requests for a given load balancer.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the work requests to retrieve.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (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.

    Example: 50 (default to 100)

  • :page (String) —

    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.

    Example: 3

Returns:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3719

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

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

  path = '/loadBalancers/{loadBalancerId}/workRequests'.sub('{loadBalancerId}', 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]

  # 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: 'LoadBalancerClient#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: 'Array<OCI::LoadBalancer::Models::WorkRequest>'
    )
  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.



95
96
97
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_backend(update_backend_details, load_balancer_id, 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:

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

    Details for updating a backend server.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the backend set and server.

  • backend_set_name (String) —

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

    Example: example_backend_set

  • backend_name (String) —

    The IP address and port of the backend server to update.

    Example: 10.0.0.3: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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3803

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

  raise "Missing the required parameter 'update_backend_details' when calling update_backend." if update_backend_details.nil?
  raise "Missing the required parameter 'load_balancer_id' when calling update_backend." if load_balancer_id.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 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(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 = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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(update_backend_set_details, load_balancer_id, 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:

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

    The details to update a backend set.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3888

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

  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 'load_balancer_id' when calling update_backend_set." if load_balancer_id.nil?
  raise "Missing the required parameter 'backend_set_name' when calling update_backend_set." if backend_set_name.nil?
  raise "Parameter value for 'load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(load_balancer_id)
  raise "Parameter value for 'backend_set_name' must not be blank" if OCI::Internal::Util.blank_string?(backend_set_name)

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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(health_checker, load_balancer_id, 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 load balancer and backend set.

Parameters:

  • health_checker (OCI::LoadBalancer::Models::UpdateHealthCheckerDetails) —

    The health check policy configuration details.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the health check policy to be updated.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 3971

def update_health_checker(health_checker, load_balancer_id, backend_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_health_checker.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker'.sub('{loadBalancerId}', 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(health_checker)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#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_hostname(update_hostname_details, load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.

Parameters:

  • update_hostname_details (OCI::LoadBalancer::Models::UpdateHostnameDetails) —

    The configuration details to update a virtual hostname.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the virtual hostname to update.

  • name (String) —

    The name of the hostname resource to update.

    Example: example_hostname_001

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4058

def update_hostname(update_hostname_details, load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_hostname.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/hostnames/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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_hostname_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_hostname') 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(update_listener_details, load_balancer_id, listener_name, opts = {}) ⇒ Response

Note:

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

Updates a listener for a given load balancer.

Parameters:

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

    Details to update a listener.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the listener to update.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4141

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

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

  path = '/loadBalancers/{loadBalancerId}/listeners/{listenerName}'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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_load_balancer(update_load_balancer_details, load_balancer_id, opts = {}) ⇒ Response

Note:

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

Updates a load balancer's configuration.

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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4220

def update_load_balancer(update_load_balancer_details, load_balancer_id, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_load_balancer.' if logger

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

  path = '/loadBalancers/{loadBalancerId}'.sub('{loadBalancerId}', 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_load_balancer_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_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_load_balancer_shape(load_balancer_id, update_load_balancer_shape_details, opts = {}) ⇒ Response

Note:

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

Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth.

Parameters:

  • load_balancer_id (String) —

    The OCID of the load balancer whose shape will be updated.

  • update_load_balancer_shape_details (OCI::LoadBalancer::Models::UpdateLoadBalancerShapeDetails) —

    The details for updating a load balancer's shape. This contains the new, desired shape.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4303

def update_load_balancer_shape(load_balancer_id, update_load_balancer_shape_details, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_load_balancer_shape.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/updateShape'.sub('{loadBalancerId}', 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_load_balancer_shape_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_load_balancer_shape') 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(update_network_security_groups_details, load_balancer_id, 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 load balancer.

Parameters:

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

    The details for updating the NSGs associated with the specified load balancer.

  • load_balancer_id (String) —

    The OCID of the load balancer to update the NSGs for.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4380

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

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

  path = '/loadBalancers/{loadBalancerId}/networkSecurityGroups'.sub('{loadBalancerId}', 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: 'LoadBalancerClient#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

#update_path_route_set(update_path_route_set_details, load_balancer_id, path_route_set_name, opts = {}) ⇒ Response

Note:

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

Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter path route rules in a path route set.

To add a new path route rule to a path route set, the pathRoutes in the update_path_route_set_details object must include both the new path route rule to add and the existing path route rules to retain.

Parameters:

  • update_path_route_set_details (OCI::LoadBalancer::Models::UpdatePathRouteSetDetails) —

    The configuration details to update a path route set.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the path route set to update.

  • path_route_set_name (String) —

    The name of the path route set to update.

    Example: example_path_route_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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4467

def update_path_route_set(update_path_route_set_details, load_balancer_id, path_route_set_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_path_route_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{pathRouteSetName}', path_route_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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_path_route_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_path_route_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_routing_policy(update_routing_policy_details, load_balancer_id, routing_policy_name, opts = {}) ⇒ Response

Note:

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

Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter routing policy rules in a routing policy.

To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.

Parameters:

  • update_routing_policy_details (OCI::LoadBalancer::Models::UpdateRoutingPolicyDetails) —

    The configuration details needed to update a routing policy.

  • load_balancer_id (String) —

    The OCID of the load balancer associated with the routing policy to update.

  • routing_policy_name (String) —

    The name of the routing policy to update.

    Example: example_routing_policy_name

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4554

def update_routing_policy(update_routing_policy_details, load_balancer_id, routing_policy_name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_routing_policy.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{routingPolicyName}', routing_policy_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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_routing_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_routing_policy') 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_rule_set(load_balancer_id, rule_set_name, update_rule_set_details, opts = {}) ⇒ Response

Note:

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

Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter the rules in a rule set.

To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.

Parameters:

  • load_balancer_id (String) —

    The OCID of the specified load balancer.

  • rule_set_name (String) —

    The name of the rule set to update.

    Example: example_rule_set

  • update_rule_set_details (OCI::LoadBalancer::Models::UpdateRuleSetDetails) —

    The configuration details to update a set of rules.

  • 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 need to contact Oracle about a particular request, please provide the request ID. (default to )

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4641

def update_rule_set(load_balancer_id, rule_set_name, update_rule_set_details, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_rule_set.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{ruleSetName}', rule_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_rule_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_rule_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_ssl_cipher_suite(update_ssl_cipher_suite_details, load_balancer_id, name, opts = {}) ⇒ Response

Note:

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

Updates an existing SSL cipher suite for the specified load balancer.

Parameters:

  • update_ssl_cipher_suite_details (OCI::LoadBalancer::Models::UpdateSSLCipherSuiteDetails) —

    The configuration details to update an SSL cipher suite.

  • load_balancer_id (String) —

    The OCID of the associated load balancer.

  • name (String) —

    The name of the SSL cipher suite to update.

    example: example_cipher_suite

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer.

    For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets.

    The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

    Example: example-etag (default to )

Returns:

  • (Response) —

    A Response object with data of type nil



4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
 
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 4725

def update_ssl_cipher_suite(update_ssl_cipher_suite_details, load_balancer_id, name, opts = {})
  logger.debug 'Calling operation LoadBalancerClient#update_ssl_cipher_suite.' if logger

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

  path = '/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}'.sub('{loadBalancerId}', load_balancer_id.to_s).sub('{name}', 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_ssl_cipher_suite_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LoadBalancerClient#update_ssl_cipher_suite') 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