Class LoadBalancerClient

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

Close the client once it is no longer needed

Adds a backend server to a backend set. This operation does not retry by default if the user has not defined a retry configuration.

Adds a backend set to a load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Creates an asynchronous request to add an SSL certificate bundle. This operation does not retry by default if the user has not defined a retry configuration.

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

Adds a listener to a load balancer. This operation does not retry by default if the user has not defined a retry configuration.

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

For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.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](https://docs.cloud.oracle.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](https://docs.cloud.oracle.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 {@link #getLoadBalancer(GetLoadBalancerRequest) getLoadBalancer} operation.

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

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

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

Creates a custom SSL cipher suite. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new LoadBalancerWaiter for resources for this service.

Removes a backend server from a given load balancer and backend set. This operation does not retry by default if the user has not defined a retry configuration.

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.

Deletes an SSL certificate bundle from a load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Deletes a hostname resource from the specified load balancer.

Deletes a listener from a load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Stops a load balancer and removes it from service. This operation does not retry by default if the user has not defined a retry configuration.

Deletes a path route set from the specified load balancer.

To delete a path route rule from a path route set, use the {@link #updatePathRouteSet(UpdatePathRouteSetRequest) updatePathRouteSet} operation.

Deletes a routing policy from the specified load balancer.

To delete a routing rule from a routing policy, use the {@link #updateRoutingPolicy(UpdateRoutingPolicyRequest) updateRoutingPolicy} operation.

Deletes a rule set from the specified load balancer.

To delete a rule from a rule set, use the {@link #updateRuleSet(UpdateRuleSetRequest) updateRuleSet} operation.

Deletes an SSL cipher suite from a load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified backend server's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the current health status of the specified backend server. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified backend set's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the health status for the specified backend set. This operation does not retry by default if the user has not defined a retry configuration.

Gets the health check policy information for a given load balancer and backend set. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified hostname resource's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified load balancer's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the health status for the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified path route set's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified routing policy. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified set of rules. This operation does not retry by default if the user has not defined a retry configuration.

Gets the specified SSL cipher suite's configuration information. This operation does not retry by default if the user has not defined a retry configuration.

Gets the waiters available for resources for this service.

Gets the details of a work request. This operation does not retry by default if the user has not defined a retry configuration.

NOTE: This function is deprecated in favor of listLoadBalancerHealthsRecordIterator function. Creates a new async iterator which will iterate over the models.LoadBalancerHealthSummary objects contained in responses from the listLoadBalancerHealths operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listLoadBalancerHealthsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listLoadBalancerHealths operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listLoadBalancersRecordIterator function. Creates a new async iterator which will iterate over the models.LoadBalancer objects contained in responses from the listLoadBalancers operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listLoadBalancersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listLoadBalancers operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.LoadBalancerPolicy objects contained in responses from the listPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listProtocolsRecordIterator function. Creates a new async iterator which will iterate over the models.LoadBalancerProtocol objects contained in responses from the listProtocols operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listProtocolsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listProtocols operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listRoutingPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.RoutingPolicy objects contained in responses from the listRoutingPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listRoutingPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRoutingPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listShapesRecordIterator function. Creates a new async iterator which will iterate over the models.LoadBalancerShape objects contained in responses from the listShapes operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

Lists all backend sets associated with a given load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Lists the backend servers for a given load balancer and backend set. This operation does not retry by default if the user has not defined a retry configuration.

Lists all SSL certificates bundles associated with a given load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Lists all hostname resources associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

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

Access control rules * Allow method rules * Request header rules * Response header rules

Lists the summary health statuses for all load balancers in the specified compartment. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.LoadBalancerHealthSummary objects contained in responses from the listLoadBalancerHealths operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listLoadBalancerHealths operation. This iterator will fetch more data from the server as needed.

Lists all load balancers in the specified compartment. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.LoadBalancer objects contained in responses from the listLoadBalancers operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listLoadBalancers operation. This iterator will fetch more data from the server as needed.

Lists all path route sets associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Lists the available load balancer policies. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.LoadBalancerPolicy objects contained in responses from the listPolicies operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator will fetch more data from the server as needed.

Lists all supported traffic protocols. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.LoadBalancerProtocol objects contained in responses from the listProtocols operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listProtocols operation. This iterator will fetch more data from the server as needed.

Lists all routing policies associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.RoutingPolicy objects contained in responses from the listRoutingPolicies operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listRoutingPolicies operation. This iterator will fetch more data from the server as needed.

Lists all rule sets associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Lists all SSL cipher suites associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Lists the valid load balancer shapes. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.LoadBalancerShape objects contained in responses from the listShapes operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator will fetch more data from the server as needed.

Lists the work requests for a given load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

Shutdown the circuit breaker used by the client when it is no longer needed

Updates the configuration of a backend server within the specified backend set. This operation does not retry by default if the user has not defined a retry configuration.

Updates a backend set. This operation does not retry by default if the user has not defined a retry configuration.

Updates the health check policy for a given load balancer and backend set. This operation does not retry by default if the user has not defined a retry configuration.

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

Updates a listener for a given load balancer. This operation does not retry by default if the user has not defined a retry configuration.

Updates a load balancer's configuration. This operation does not retry by default if the user has not defined a retry configuration.

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

Updates the network security groups associated with the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.

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 {@link #updatePathRouteSetDetails(UpdatePathRouteSetDetailsRequest) updatePathRouteSetDetails} object must include both the new path route rule to add and the existing path route rules to retain.

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

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

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

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

Updates an existing SSL cipher suite for the specified load balancer. This operation does not retry by default if the user has not defined a retry configuration.