Class: OCI::LoadBalancer::LoadBalancerClient
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::LoadBalancerClient
- Defined in:
- lib/oci/load_balancer/load_balancer_client.rb
Overview
API for the Load Balancing Service
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_backend(create_backend_details, load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Adds a backend server to a backend set.
-
#create_backend_set(create_backend_set_details, load_balancer_id, opts = {}) ⇒ Response
Adds a backend set to a load balancer.
-
#create_certificate(create_certificate_details, load_balancer_id, opts = {}) ⇒ Response
Creates an asynchronous request to add an SSL certificate bundle.
-
#create_hostname(create_hostname_details, load_balancer_id, opts = {}) ⇒ Response
Adds a hostname resource to the specified load balancer.
-
#create_listener(create_listener_details, load_balancer_id, opts = {}) ⇒ Response
Adds a listener to a load balancer.
-
#create_load_balancer(create_load_balancer_details, opts = {}) ⇒ Response
Creates a new load balancer in the specified compartment.
-
#create_path_route_set(create_path_route_set_details, load_balancer_id, opts = {}) ⇒ Response
Adds a path route set to a load balancer.
-
#delete_backend(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Removes a backend server from a given load balancer and backend set.
-
#delete_backend_set(load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Deletes the specified backend set.
-
#delete_certificate(load_balancer_id, certificate_name, opts = {}) ⇒ Response
Deletes an SSL certificate bundle from a load balancer.
-
#delete_hostname(load_balancer_id, name, opts = {}) ⇒ Response
Deletes a hostname resource from the specified load balancer.
-
#delete_listener(load_balancer_id, listener_name, opts = {}) ⇒ Response
Deletes a listener from a load balancer.
-
#delete_load_balancer(load_balancer_id, opts = {}) ⇒ Response
Stops a load balancer and removes it from service.
-
#delete_path_route_set(load_balancer_id, path_route_set_name, opts = {}) ⇒ Response
Deletes a path route set from the specified load balancer.
-
#get_backend(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Gets the specified backend server’s configuration information.
-
#get_backend_health(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Gets the current health status of the specified backend server.
-
#get_backend_set(load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Gets the specified backend set’s configuration information.
-
#get_backend_set_health(load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Gets the health status for the specified backend set.
-
#get_health_checker(load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Gets the health check policy information for a given load balancer and backend set.
-
#get_hostname(load_balancer_id, name, opts = {}) ⇒ Response
Gets the specified hostname resource’s configuration information.
-
#get_load_balancer(load_balancer_id, opts = {}) ⇒ Response
Gets the specified load balancer’s configuration information.
-
#get_load_balancer_health(load_balancer_id, opts = {}) ⇒ Response
Gets the health status for the specified load balancer.
-
#get_path_route_set(load_balancer_id, path_route_set_name, opts = {}) ⇒ Response
Gets the specified path route set’s configuration information.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the details of a work request.
-
#initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LoadBalancerClient
constructor
Creates a new LoadBalancerClient.
-
#list_backend_sets(load_balancer_id, opts = {}) ⇒ Response
Lists all backend sets associated with a given load balancer.
-
#list_backends(load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Lists the backend servers for a given load balancer and backend set.
-
#list_certificates(load_balancer_id, opts = {}) ⇒ Response
Lists all SSL certificates bundles associated with a given load balancer.
-
#list_hostnames(load_balancer_id, opts = {}) ⇒ Response
Lists all hostname resources associated with the specified load balancer.
-
#list_load_balancer_healths(compartment_id, opts = {}) ⇒ Response
Lists the summary health statuses for all load balancers in the specified compartment.
-
#list_load_balancers(compartment_id, opts = {}) ⇒ Response
Lists all load balancers in the specified compartment.
-
#list_path_route_sets(load_balancer_id, opts = {}) ⇒ Response
Lists all path route sets associated with the specified load balancer.
-
#list_policies(compartment_id, opts = {}) ⇒ Response
Lists the available load balancer policies.
-
#list_protocols(compartment_id, opts = {}) ⇒ Response
Lists all supported traffic protocols.
-
#list_shapes(compartment_id, opts = {}) ⇒ Response
Lists the valid load balancer shapes.
-
#list_work_requests(load_balancer_id, opts = {}) ⇒ Response
Lists the work requests for a given load balancer.
-
#logger ⇒ Logger
The logger for this client.
-
#update_backend(update_backend_details, load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Updates the configuration of a backend server within the specified backend set.
-
#update_backend_set(update_backend_set_details, load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Updates a backend set.
-
#update_health_checker(health_checker, load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Updates the health check policy for a given load balancer and backend set.
-
#update_hostname(update_hostname_details, load_balancer_id, name, opts = {}) ⇒ Response
Overwrites an existing hostname resource on the specified load balancer.
-
#update_listener(update_listener_details, load_balancer_id, listener_name, opts = {}) ⇒ Response
Updates a listener for a given load balancer.
-
#update_load_balancer(update_load_balancer_details, load_balancer_id, opts = {}) ⇒ Response
Updates a load balancer’s configuration.
-
#update_path_route_set(update_path_route_set_details, load_balancer_id, path_route_set_name, opts = {}) ⇒ Response
Overwrites an existing path route set on the specified load balancer.
Constructor Details
#initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LoadBalancerClient
Creates a new LoadBalancerClient. If a config is not specified, then the global OCI.config will be used.
A region must be specified in either the config or the region parameter. If specified in both, then the region parameter will be used.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 48 def initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
12 13 14 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 16 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
26 27 28 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 26 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
22 23 24 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#create_backend(create_backend_details, load_balancer_id, backend_set_name, opts = {}) ⇒ Response
Adds a backend server to a backend set.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 122 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[:'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.(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
Adds a backend set to a load balancer.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 188 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] # 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.(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
Creates an asynchronous request to add an SSL certificate bundle.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 252 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] # 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.(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
Adds a hostname resource to the specified load balancer. For more information, see [Managing Request Routing](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm).
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 318 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[:'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.(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
Adds a listener to a load balancer.
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 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 382 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] # 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.(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
Creates a new load balancer in the specified compartment. For general information about load balancers, see [Overview of the Load Balancing Service](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Concepts/balanceoverview.htm).
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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm). 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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
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.
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 472 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.(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
Adds a path route set to a load balancer. For more information, see [Managing Request Routing](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm).
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 567 568 569 570 571 572 573 574 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 536 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] # 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.(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 |
#delete_backend(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Removes a backend server from a given load balancer and backend set.
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 601 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
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.
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 666 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Deletes an SSL certificate bundle from a load balancer.
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 728 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Deletes a hostname resource from the specified load balancer.
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 814 815 816 817 818 819 820 821 822 823 824 825 826 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 789 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Deletes a listener from a load balancer.
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 849 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Stops a load balancer and removes it from service.
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 905 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
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.
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 967 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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 |
#get_backend(load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Gets the specified backend server’s configuration information.
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1031 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the current health status of the specified backend server.
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 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1098 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the specified backend set’s configuration information.
1161 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 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1161 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the health status for the specified backend set.
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 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 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1222 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the health check policy information for a given load balancer and backend set.
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1283 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the specified hostname resource’s configuration information.
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1344 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the specified load balancer’s configuration information.
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1401 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the health status for the specified load balancer.
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 1492 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1456 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Gets the specified path route set’s configuration information.
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1515 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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_work_request(work_request_id, opts = {}) ⇒ Response
Gets the details of a work request.
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1572 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.(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
Lists all backend sets associated with a given load balancer.
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1627 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Lists the backend servers for a given load balancer and backend set.
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 1720 1721 1722 1723 1724 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1686 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Lists all SSL certificates bundles associated with a given load balancer.
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1745 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Lists all hostname resources associated with the specified load balancer.
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1802 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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_load_balancer_healths(compartment_id, opts = {}) ⇒ Response
Lists the summary health statuses for all load balancers in the specified compartment.
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1865 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.(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
Lists all load balancers in the specified compartment.
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 1949 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.(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
Lists all path route sets associated with the specified load balancer.
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2025 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Lists the available load balancer policies.
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2088 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.(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
Lists all supported traffic protocols.
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2153 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.(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_shapes(compartment_id, opts = {}) ⇒ Response
Lists the valid load balancer shapes.
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 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2218 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.(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_work_requests(load_balancer_id, opts = {}) ⇒ Response
Lists the work requests for a given load balancer.
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 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2283 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.(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.
93 94 95 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 93 def logger @api_client.config.logger end |
#update_backend(update_backend_details, load_balancer_id, backend_set_name, backend_name, opts = {}) ⇒ Response
Updates the configuration of a backend server within the specified backend set.
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 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2355 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] # 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.(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
Updates a backend set.
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 2460 2461 2462 2463 2464 2465 2466 2467 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2427 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] # 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.(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
Updates the health check policy for a given load balancer and backend set.
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 2534 2535 2536 2537 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2497 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] # 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.(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
Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2565 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] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_hostname_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Updates a listener for a given load balancer.
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 2665 2666 2667 2668 2669 2670 2671 2672 2673 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2633 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] # 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.(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
Updates a load balancer’s configuration.
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 2733 2734 2735 2736 2737 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2699 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[:'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.(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_path_route_set(update_path_route_set_details, load_balancer_id, path_route_set_name, opts = {}) ⇒ Response
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.
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 2807 2808 2809 2810 2811 2812 2813 |
# File 'lib/oci/load_balancer/load_balancer_client.rb', line 2773 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[:'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.(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 |