Interface LoadBalancer
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
LoadBalancerClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public interface LoadBalancer extends AutoCloseable
API for the Load Balancing service.Use this API to manage load balancers, backend sets, and related items. For more information, see Overview of Load Balancing.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChangeLoadBalancerCompartmentResponse
changeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest request)
Moves a load balancer into a different compartment within the same tenancy.CreateBackendResponse
createBackend(CreateBackendRequest request)
Adds a backend server to a backend set.CreateBackendSetResponse
createBackendSet(CreateBackendSetRequest request)
Adds a backend set to a load balancer.CreateCertificateResponse
createCertificate(CreateCertificateRequest request)
Creates an asynchronous request to add an SSL certificate bundle.CreateHostnameResponse
createHostname(CreateHostnameRequest request)
Adds a hostname resource to the specified load balancer.CreateListenerResponse
createListener(CreateListenerRequest request)
Adds a listener to a load balancer.CreateLoadBalancerResponse
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a new load balancer in the specified compartment.CreatePathRouteSetResponse
createPathRouteSet(CreatePathRouteSetRequest request)
Adds a path route set to a load balancer.CreateRoutingPolicyResponse
createRoutingPolicy(CreateRoutingPolicyRequest request)
Adds a routing policy to a load balancer.CreateRuleSetResponse
createRuleSet(CreateRuleSetRequest request)
Creates a new rule set associated with the specified load balancer.CreateSSLCipherSuiteResponse
createSSLCipherSuite(CreateSSLCipherSuiteRequest request)
Creates a custom SSL cipher suite.DeleteBackendResponse
deleteBackend(DeleteBackendRequest request)
Removes a backend server from a given load balancer and backend set.DeleteBackendSetResponse
deleteBackendSet(DeleteBackendSetRequest request)
Deletes the specified backend set.DeleteCertificateResponse
deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL certificate bundle from a load balancer.DeleteHostnameResponse
deleteHostname(DeleteHostnameRequest request)
Deletes a hostname resource from the specified load balancer.DeleteListenerResponse
deleteListener(DeleteListenerRequest request)
Deletes a listener from a load balancer.DeleteLoadBalancerResponse
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Stops a load balancer and removes it from service.DeletePathRouteSetResponse
deletePathRouteSet(DeletePathRouteSetRequest request)
Deletes a path route set from the specified load balancer.DeleteRoutingPolicyResponse
deleteRoutingPolicy(DeleteRoutingPolicyRequest request)
Deletes a routing policy from the specified load balancer.DeleteRuleSetResponse
deleteRuleSet(DeleteRuleSetRequest request)
Deletes a rule set from the specified load balancer.DeleteSSLCipherSuiteResponse
deleteSSLCipherSuite(DeleteSSLCipherSuiteRequest request)
Deletes an SSL cipher suite from a load balancer.GetBackendResponse
getBackend(GetBackendRequest request)
Gets the specified backend server’s configuration information.GetBackendHealthResponse
getBackendHealth(GetBackendHealthRequest request)
Gets the current health status of the specified backend server.GetBackendSetResponse
getBackendSet(GetBackendSetRequest request)
Gets the specified backend set’s configuration information.GetBackendSetHealthResponse
getBackendSetHealth(GetBackendSetHealthRequest request)
Gets the health status for the specified backend set.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)GetHealthCheckerResponse
getHealthChecker(GetHealthCheckerRequest request)
Gets the health check policy information for a given load balancer and backend set.GetHostnameResponse
getHostname(GetHostnameRequest request)
Gets the specified hostname resource’s configuration information.GetLoadBalancerResponse
getLoadBalancer(GetLoadBalancerRequest request)
Gets the specified load balancer’s configuration information.GetLoadBalancerHealthResponse
getLoadBalancerHealth(GetLoadBalancerHealthRequest request)
Gets the health status for the specified load balancer.LoadBalancerPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPathRouteSetResponse
getPathRouteSet(GetPathRouteSetRequest request)
Gets the specified path route set’s configuration information.GetRoutingPolicyResponse
getRoutingPolicy(GetRoutingPolicyRequest request)
Gets the specified routing policy.GetRuleSetResponse
getRuleSet(GetRuleSetRequest request)
Gets the specified set of rules.GetSSLCipherSuiteResponse
getSSLCipherSuite(GetSSLCipherSuiteRequest request)
Gets the specified SSL cipher suite’s configuration information.LoadBalancerWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.ListBackendsResponse
listBackends(ListBackendsRequest request)
Lists the backend servers for a given load balancer and backend set.ListBackendSetsResponse
listBackendSets(ListBackendSetsRequest request)
Lists all backend sets associated with a given load balancer.ListCertificatesResponse
listCertificates(ListCertificatesRequest request)
Lists all SSL certificates bundles associated with a given load balancer.ListHostnamesResponse
listHostnames(ListHostnamesRequest request)
Lists all hostname resources associated with the specified load balancer.ListListenerRulesResponse
listListenerRules(ListListenerRulesRequest request)
Lists all of the rules from all of the rule sets associated with the specified listener.ListLoadBalancerHealthsResponse
listLoadBalancerHealths(ListLoadBalancerHealthsRequest request)
Lists the summary health statuses for all load balancers in the specified compartment.ListLoadBalancersResponse
listLoadBalancers(ListLoadBalancersRequest request)
Lists all load balancers in the specified compartment.ListPathRouteSetsResponse
listPathRouteSets(ListPathRouteSetsRequest request)
Lists all path route sets associated with the specified load balancer.ListPoliciesResponse
listPolicies(ListPoliciesRequest request)
Lists the available load balancer policies.ListProtocolsResponse
listProtocols(ListProtocolsRequest request)
Lists all supported traffic protocols.ListRoutingPoliciesResponse
listRoutingPolicies(ListRoutingPoliciesRequest request)
Lists all routing policies associated with the specified load balancer.ListRuleSetsResponse
listRuleSets(ListRuleSetsRequest request)
Lists all rule sets associated with the specified load balancer.ListShapesResponse
listShapes(ListShapesRequest request)
Lists the valid load balancer shapes.ListSSLCipherSuitesResponse
listSSLCipherSuites(ListSSLCipherSuitesRequest request)
Lists all SSL cipher suites associated with the specified load balancer.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests for a given load balancer.void
refreshClient()
Rebuilds the client from scratch.void
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).UpdateBackendResponse
updateBackend(UpdateBackendRequest request)
Updates the configuration of a backend server within the specified backend set.UpdateBackendSetResponse
updateBackendSet(UpdateBackendSetRequest request)
Updates a backend set.UpdateHealthCheckerResponse
updateHealthChecker(UpdateHealthCheckerRequest request)
Updates the health check policy for a given load balancer and backend set.UpdateHostnameResponse
updateHostname(UpdateHostnameRequest request)
Overwrites an existing hostname resource on the specified load balancer.UpdateListenerResponse
updateListener(UpdateListenerRequest request)
Updates a listener for a given load balancer.UpdateLoadBalancerResponse
updateLoadBalancer(UpdateLoadBalancerRequest request)
Updates a load balancer’s configuration.UpdateLoadBalancerShapeResponse
updateLoadBalancerShape(UpdateLoadBalancerShapeRequest request)
Update the shape of a load balancer.UpdateNetworkSecurityGroupsResponse
updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request)
Updates the network security groups associated with the specified load balancer.UpdatePathRouteSetResponse
updatePathRouteSet(UpdatePathRouteSetRequest request)
Overwrites an existing path route set on the specified load balancer.UpdateRoutingPolicyResponse
updateRoutingPolicy(UpdateRoutingPolicyRequest request)
Overwrites an existing routing policy on the specified load balancer.UpdateRuleSetResponse
updateRuleSet(UpdateRuleSetRequest request)
Overwrites an existing set of rules on the specified load balancer.UpdateSSLCipherSuiteResponse
updateSSLCipherSuite(UpdateSSLCipherSuiteRequest request)
Updates an existing SSL cipher suite for the specified load balancer.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
changeLoadBalancerCompartment
ChangeLoadBalancerCompartmentResponse changeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest request)
Moves a load balancer into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ChangeLoadBalancerCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeLoadBalancerCompartment API.
-
createBackend
CreateBackendResponse createBackend(CreateBackendRequest request)
Adds a backend server to a backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateBackendExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBackend API.
-
createBackendSet
CreateBackendSetResponse createBackendSet(CreateBackendSetRequest request)
Adds a backend set to a load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateBackendSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBackendSet API.
-
createCertificate
CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Creates an asynchronous request to add an SSL certificate bundle.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCertificate API.
-
createHostname
CreateHostnameResponse createHostname(CreateHostnameRequest request)
Adds a hostname resource to the specified load balancer.For more information, see Managing Request Routing.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateHostnameExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateHostname API.
-
createListener
CreateListenerResponse createListener(CreateListenerRequest request)
Adds a listener to a load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateListenerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateListener API.
-
createLoadBalancer
CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest request)
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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
getLoadBalancer
operation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLoadBalancer API.
-
createPathRouteSet
CreatePathRouteSetResponse createPathRouteSet(CreatePathRouteSetRequest request)
Adds a path route set to a load balancer.For more information, see Managing Request Routing.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreatePathRouteSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePathRouteSet API.
-
createRoutingPolicy
CreateRoutingPolicyResponse createRoutingPolicy(CreateRoutingPolicyRequest request)
Adds a routing policy to a load balancer.For more information, see Managing Request Routing.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateRoutingPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateRoutingPolicy API.
-
createRuleSet
CreateRuleSetResponse createRuleSet(CreateRuleSetRequest request)
Creates a new rule set associated with the specified load balancer.For more information, see Managing Rule Sets.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateRuleSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateRuleSet API.
-
createSSLCipherSuite
CreateSSLCipherSuiteResponse createSSLCipherSuite(CreateSSLCipherSuiteRequest request)
Creates a custom SSL cipher suite.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/CreateSSLCipherSuiteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSSLCipherSuite API.
-
deleteBackend
DeleteBackendResponse deleteBackend(DeleteBackendRequest request)
Removes a backend server from a given load balancer and backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteBackendExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBackend API.
-
deleteBackendSet
DeleteBackendSetResponse deleteBackendSet(DeleteBackendSetRequest request)
Deletes the specified backend set.Note that deleting a backend set removes its backend servers from the load balancer.
Before you can delete a backend set, you must remove it from any active listeners.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteBackendSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBackendSet API.
-
deleteCertificate
DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL certificate bundle from a load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCertificate API.
-
deleteHostname
DeleteHostnameResponse deleteHostname(DeleteHostnameRequest request)
Deletes a hostname resource from the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteHostnameExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteHostname API.
-
deleteListener
DeleteListenerResponse deleteListener(DeleteListenerRequest request)
Deletes a listener from a load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteListenerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteListener API.
-
deleteLoadBalancer
DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest request)
Stops a load balancer and removes it from service.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLoadBalancer API.
-
deletePathRouteSet
DeletePathRouteSetResponse deletePathRouteSet(DeletePathRouteSetRequest request)
Deletes a path route set from the specified load balancer.To delete a path route rule from a path route set, use the
updatePathRouteSet
operation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeletePathRouteSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePathRouteSet API.
-
deleteRoutingPolicy
DeleteRoutingPolicyResponse deleteRoutingPolicy(DeleteRoutingPolicyRequest request)
Deletes a routing policy from the specified load balancer.To delete a routing rule from a routing policy, use the
updateRoutingPolicy
operation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteRoutingPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteRoutingPolicy API.
-
deleteRuleSet
DeleteRuleSetResponse deleteRuleSet(DeleteRuleSetRequest request)
Deletes a rule set from the specified load balancer.To delete a rule from a rule set, use the
updateRuleSet
operation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteRuleSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteRuleSet API.
-
deleteSSLCipherSuite
DeleteSSLCipherSuiteResponse deleteSSLCipherSuite(DeleteSSLCipherSuiteRequest request)
Deletes an SSL cipher suite from a load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/DeleteSSLCipherSuiteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSSLCipherSuite API.
-
getBackend
GetBackendResponse getBackend(GetBackendRequest request)
Gets the specified backend server’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetBackendExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackend API.
-
getBackendHealth
GetBackendHealthResponse getBackendHealth(GetBackendHealthRequest request)
Gets the current health status of the specified backend server.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetBackendHealthExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackendHealth API.
-
getBackendSet
GetBackendSetResponse getBackendSet(GetBackendSetRequest request)
Gets the specified backend set’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetBackendSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackendSet API.
-
getBackendSetHealth
GetBackendSetHealthResponse getBackendSetHealth(GetBackendSetHealthRequest request)
Gets the health status for the specified backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetBackendSetHealthExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackendSetHealth API.
-
getHealthChecker
GetHealthCheckerResponse getHealthChecker(GetHealthCheckerRequest request)
Gets the health check policy information for a given load balancer and backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetHealthCheckerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHealthChecker API.
-
getHostname
GetHostnameResponse getHostname(GetHostnameRequest request)
Gets the specified hostname resource’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetHostnameExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHostname API.
-
getLoadBalancer
GetLoadBalancerResponse getLoadBalancer(GetLoadBalancerRequest request)
Gets the specified load balancer’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLoadBalancer API.
-
getLoadBalancerHealth
GetLoadBalancerHealthResponse getLoadBalancerHealth(GetLoadBalancerHealthRequest request)
Gets the health status for the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetLoadBalancerHealthExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLoadBalancerHealth API.
-
getPathRouteSet
GetPathRouteSetResponse getPathRouteSet(GetPathRouteSetRequest request)
Gets the specified path route set’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetPathRouteSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPathRouteSet API.
-
getRoutingPolicy
GetRoutingPolicyResponse getRoutingPolicy(GetRoutingPolicyRequest request)
Gets the specified routing policy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetRoutingPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRoutingPolicy API.
-
getRuleSet
GetRuleSetResponse getRuleSet(GetRuleSetRequest request)
Gets the specified set of rules.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetRuleSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRuleSet API.
-
getSSLCipherSuite
GetSSLCipherSuiteResponse getSSLCipherSuite(GetSSLCipherSuiteRequest request)
Gets the specified SSL cipher suite’s configuration information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetSSLCipherSuiteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSSLCipherSuite API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
listBackendSets
ListBackendSetsResponse listBackendSets(ListBackendSetsRequest request)
Lists all backend sets associated with a given load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListBackendSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBackendSets API.
-
listBackends
ListBackendsResponse listBackends(ListBackendsRequest request)
Lists the backend servers for a given load balancer and backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListBackendsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBackends API.
-
listCertificates
ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Lists all SSL certificates bundles associated with a given load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListCertificatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCertificates API.
-
listHostnames
ListHostnamesResponse listHostnames(ListHostnamesRequest request)
Lists all hostname resources associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListHostnamesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHostnames API.
-
listListenerRules
ListListenerRulesResponse listListenerRules(ListListenerRulesRequest request)
Lists all of the rules from all of the rule sets associated with the specified listener.The response organizes the rules in the following order:
Access control rules * Allow method rules * Request header rules * Response header rules
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListListenerRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListListenerRules API.
-
listLoadBalancerHealths
ListLoadBalancerHealthsResponse listLoadBalancerHealths(ListLoadBalancerHealthsRequest request)
Lists the summary health statuses for all load balancers in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListLoadBalancerHealthsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLoadBalancerHealths API.
-
listLoadBalancers
ListLoadBalancersResponse listLoadBalancers(ListLoadBalancersRequest request)
Lists all load balancers in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListLoadBalancersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLoadBalancers API.
-
listPathRouteSets
ListPathRouteSetsResponse listPathRouteSets(ListPathRouteSetsRequest request)
Lists all path route sets associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListPathRouteSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPathRouteSets API.
-
listPolicies
ListPoliciesResponse listPolicies(ListPoliciesRequest request)
Lists the available load balancer policies.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPolicies API.
-
listProtocols
ListProtocolsResponse listProtocols(ListProtocolsRequest request)
Lists all supported traffic protocols.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListProtocolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProtocols API.
-
listRoutingPolicies
ListRoutingPoliciesResponse listRoutingPolicies(ListRoutingPoliciesRequest request)
Lists all routing policies associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListRoutingPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRoutingPolicies API.
-
listRuleSets
ListRuleSetsResponse listRuleSets(ListRuleSetsRequest request)
Lists all rule sets associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListRuleSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRuleSets API.
-
listSSLCipherSuites
ListSSLCipherSuitesResponse listSSLCipherSuites(ListSSLCipherSuitesRequest request)
Lists all SSL cipher suites associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListSSLCipherSuitesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSSLCipherSuites API.
-
listShapes
ListShapesResponse listShapes(ListShapesRequest request)
Lists the valid load balancer shapes.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListShapesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListShapes API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests for a given load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
updateBackend
UpdateBackendResponse updateBackend(UpdateBackendRequest request)
Updates the configuration of a backend server within the specified backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateBackendExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBackend API.
-
updateBackendSet
UpdateBackendSetResponse updateBackendSet(UpdateBackendSetRequest request)
Updates a backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateBackendSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBackendSet API.
-
updateHealthChecker
UpdateHealthCheckerResponse updateHealthChecker(UpdateHealthCheckerRequest request)
Updates the health check policy for a given load balancer and backend set.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateHealthCheckerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateHealthChecker API.
-
updateHostname
UpdateHostnameResponse updateHostname(UpdateHostnameRequest request)
Overwrites an existing hostname resource on the specified load balancer.Use this operation to change a virtual hostname.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateHostnameExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateHostname API.
-
updateListener
UpdateListenerResponse updateListener(UpdateListenerRequest request)
Updates a listener for a given load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateListenerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateListener API.
-
updateLoadBalancer
UpdateLoadBalancerResponse updateLoadBalancer(UpdateLoadBalancerRequest request)
Updates a load balancer’s configuration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateLoadBalancerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLoadBalancer API.
-
updateLoadBalancerShape
UpdateLoadBalancerShapeResponse updateLoadBalancerShape(UpdateLoadBalancerShapeRequest request)
Update the shape of a load balancer.The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateLoadBalancerShapeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLoadBalancerShape API.
-
updateNetworkSecurityGroups
UpdateNetworkSecurityGroupsResponse updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request)
Updates the network security groups associated with the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateNetworkSecurityGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateNetworkSecurityGroups API.
-
updatePathRouteSet
UpdatePathRouteSetResponse updatePathRouteSet(UpdatePathRouteSetRequest request)
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
updatePathRouteSetDetails
object must include both the new path route rule to add and the existing path route rules to retain.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdatePathRouteSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePathRouteSet API.
-
updateRoutingPolicy
UpdateRoutingPolicyResponse updateRoutingPolicy(UpdateRoutingPolicyRequest request)
Overwrites an existing routing policy on the specified load balancer.Use this operation to add, delete, or alter routing policy rules in a routing policy.
To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateRoutingPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateRoutingPolicy API.
-
updateRuleSet
UpdateRuleSetResponse updateRuleSet(UpdateRuleSetRequest request)
Overwrites an existing set of rules on the specified load balancer.Use this operation to add or alter the rules in a rule set.
To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateRuleSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateRuleSet API.
-
updateSSLCipherSuite
UpdateSSLCipherSuiteResponse updateSSLCipherSuite(UpdateSSLCipherSuiteRequest request)
Updates an existing SSL cipher suite for the specified load balancer.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/loadbalancer/UpdateSSLCipherSuiteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSSLCipherSuite API.
-
getWaiters
LoadBalancerWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
LoadBalancerPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Returns:
- The service paginators.
-
-