Class LoadBalancerClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.loadbalancer.LoadBalancerClient
-
- All Implemented Interfaces:
LoadBalancer
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public class LoadBalancerClient extends BaseSyncClient implements LoadBalancer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LoadBalancerClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for LoadBalancer.
-
Constructor Summary
Constructors Constructor Description LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LoadBalancerClient.Builder
builder()
Create a builder for this client.ChangeLoadBalancerCompartmentResponse
changeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest request)
Moves a load balancer into a different compartment within the same tenancy.void
close()
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
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
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.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.void
setEndpoint(String endpoint)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.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 useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.loadbalancer.LoadBalancer
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
LoadBalancerClient
@Deprecated public LoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-LoadBalancerClient.Builder.executorService
-
-
Method Detail
-
builder
public static LoadBalancerClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:LoadBalancer
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.- Specified by:
setRegion
in interfaceLoadBalancer
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:LoadBalancer
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
.- Specified by:
setRegion
in interfaceLoadBalancer
- Parameters:
regionId
- The public region ID.
-
changeLoadBalancerCompartment
public ChangeLoadBalancerCompartmentResponse changeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest request)
Description copied from interface:LoadBalancer
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.
- Specified by:
changeLoadBalancerCompartment
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBackend
public CreateBackendResponse createBackend(CreateBackendRequest request)
Description copied from interface:LoadBalancer
Adds a backend server to a backend set.- Specified by:
createBackend
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBackendSet
public CreateBackendSetResponse createBackendSet(CreateBackendSetRequest request)
Description copied from interface:LoadBalancer
Adds a backend set to a load balancer.- Specified by:
createBackendSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCertificate
public CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Description copied from interface:LoadBalancer
Creates an asynchronous request to add an SSL certificate bundle.- Specified by:
createCertificate
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createHostname
public CreateHostnameResponse createHostname(CreateHostnameRequest request)
Description copied from interface:LoadBalancer
Adds a hostname resource to the specified load balancer.For more information, see Managing Request Routing.
- Specified by:
createHostname
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createListener
public CreateListenerResponse createListener(CreateListenerRequest request)
Description copied from interface:LoadBalancer
Adds a listener to a load balancer.- Specified by:
createListener
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLoadBalancer
public CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest request)
Description copied from interface:LoadBalancer
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.- Specified by:
createLoadBalancer
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPathRouteSet
public CreatePathRouteSetResponse createPathRouteSet(CreatePathRouteSetRequest request)
Description copied from interface:LoadBalancer
Adds a path route set to a load balancer.For more information, see Managing Request Routing.
- Specified by:
createPathRouteSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRoutingPolicy
public CreateRoutingPolicyResponse createRoutingPolicy(CreateRoutingPolicyRequest request)
Description copied from interface:LoadBalancer
Adds a routing policy to a load balancer.For more information, see Managing Request Routing.
- Specified by:
createRoutingPolicy
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRuleSet
public CreateRuleSetResponse createRuleSet(CreateRuleSetRequest request)
Description copied from interface:LoadBalancer
Creates a new rule set associated with the specified load balancer.For more information, see Managing Rule Sets.
- Specified by:
createRuleSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSSLCipherSuite
public CreateSSLCipherSuiteResponse createSSLCipherSuite(CreateSSLCipherSuiteRequest request)
Description copied from interface:LoadBalancer
Creates a custom SSL cipher suite.- Specified by:
createSSLCipherSuite
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBackend
public DeleteBackendResponse deleteBackend(DeleteBackendRequest request)
Description copied from interface:LoadBalancer
Removes a backend server from a given load balancer and backend set.- Specified by:
deleteBackend
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBackendSet
public DeleteBackendSetResponse deleteBackendSet(DeleteBackendSetRequest request)
Description copied from interface:LoadBalancer
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.
- Specified by:
deleteBackendSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCertificate
public DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
Description copied from interface:LoadBalancer
Deletes an SSL certificate bundle from a load balancer.- Specified by:
deleteCertificate
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHostname
public DeleteHostnameResponse deleteHostname(DeleteHostnameRequest request)
Description copied from interface:LoadBalancer
Deletes a hostname resource from the specified load balancer.- Specified by:
deleteHostname
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteListener
public DeleteListenerResponse deleteListener(DeleteListenerRequest request)
Description copied from interface:LoadBalancer
Deletes a listener from a load balancer.- Specified by:
deleteListener
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLoadBalancer
public DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest request)
Description copied from interface:LoadBalancer
Stops a load balancer and removes it from service.- Specified by:
deleteLoadBalancer
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePathRouteSet
public DeletePathRouteSetResponse deletePathRouteSet(DeletePathRouteSetRequest request)
Description copied from interface:LoadBalancer
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.- Specified by:
deletePathRouteSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRoutingPolicy
public DeleteRoutingPolicyResponse deleteRoutingPolicy(DeleteRoutingPolicyRequest request)
Description copied from interface:LoadBalancer
Deletes a routing policy from the specified load balancer.To delete a routing rule from a routing policy, use the
updateRoutingPolicy
operation.- Specified by:
deleteRoutingPolicy
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRuleSet
public DeleteRuleSetResponse deleteRuleSet(DeleteRuleSetRequest request)
Description copied from interface:LoadBalancer
Deletes a rule set from the specified load balancer.To delete a rule from a rule set, use the
updateRuleSet
operation.- Specified by:
deleteRuleSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSSLCipherSuite
public DeleteSSLCipherSuiteResponse deleteSSLCipherSuite(DeleteSSLCipherSuiteRequest request)
Description copied from interface:LoadBalancer
Deletes an SSL cipher suite from a load balancer.- Specified by:
deleteSSLCipherSuite
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBackend
public GetBackendResponse getBackend(GetBackendRequest request)
Description copied from interface:LoadBalancer
Gets the specified backend server’s configuration information.- Specified by:
getBackend
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBackendHealth
public GetBackendHealthResponse getBackendHealth(GetBackendHealthRequest request)
Description copied from interface:LoadBalancer
Gets the current health status of the specified backend server.- Specified by:
getBackendHealth
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBackendSet
public GetBackendSetResponse getBackendSet(GetBackendSetRequest request)
Description copied from interface:LoadBalancer
Gets the specified backend set’s configuration information.- Specified by:
getBackendSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBackendSetHealth
public GetBackendSetHealthResponse getBackendSetHealth(GetBackendSetHealthRequest request)
Description copied from interface:LoadBalancer
Gets the health status for the specified backend set.- Specified by:
getBackendSetHealth
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHealthChecker
public GetHealthCheckerResponse getHealthChecker(GetHealthCheckerRequest request)
Description copied from interface:LoadBalancer
Gets the health check policy information for a given load balancer and backend set.- Specified by:
getHealthChecker
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHostname
public GetHostnameResponse getHostname(GetHostnameRequest request)
Description copied from interface:LoadBalancer
Gets the specified hostname resource’s configuration information.- Specified by:
getHostname
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLoadBalancer
public GetLoadBalancerResponse getLoadBalancer(GetLoadBalancerRequest request)
Description copied from interface:LoadBalancer
Gets the specified load balancer’s configuration information.- Specified by:
getLoadBalancer
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLoadBalancerHealth
public GetLoadBalancerHealthResponse getLoadBalancerHealth(GetLoadBalancerHealthRequest request)
Description copied from interface:LoadBalancer
Gets the health status for the specified load balancer.- Specified by:
getLoadBalancerHealth
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPathRouteSet
public GetPathRouteSetResponse getPathRouteSet(GetPathRouteSetRequest request)
Description copied from interface:LoadBalancer
Gets the specified path route set’s configuration information.- Specified by:
getPathRouteSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRoutingPolicy
public GetRoutingPolicyResponse getRoutingPolicy(GetRoutingPolicyRequest request)
Description copied from interface:LoadBalancer
Gets the specified routing policy.- Specified by:
getRoutingPolicy
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRuleSet
public GetRuleSetResponse getRuleSet(GetRuleSetRequest request)
Description copied from interface:LoadBalancer
Gets the specified set of rules.- Specified by:
getRuleSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSSLCipherSuite
public GetSSLCipherSuiteResponse getSSLCipherSuite(GetSSLCipherSuiteRequest request)
Description copied from interface:LoadBalancer
Gets the specified SSL cipher suite’s configuration information.- Specified by:
getSSLCipherSuite
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:LoadBalancer
Gets the details of a work request.- Specified by:
getWorkRequest
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBackendSets
public ListBackendSetsResponse listBackendSets(ListBackendSetsRequest request)
Description copied from interface:LoadBalancer
Lists all backend sets associated with a given load balancer.- Specified by:
listBackendSets
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBackends
public ListBackendsResponse listBackends(ListBackendsRequest request)
Description copied from interface:LoadBalancer
Lists the backend servers for a given load balancer and backend set.- Specified by:
listBackends
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCertificates
public ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Description copied from interface:LoadBalancer
Lists all SSL certificates bundles associated with a given load balancer.- Specified by:
listCertificates
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHostnames
public ListHostnamesResponse listHostnames(ListHostnamesRequest request)
Description copied from interface:LoadBalancer
Lists all hostname resources associated with the specified load balancer.- Specified by:
listHostnames
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listListenerRules
public ListListenerRulesResponse listListenerRules(ListListenerRulesRequest request)
Description copied from interface:LoadBalancer
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
- Specified by:
listListenerRules
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLoadBalancerHealths
public ListLoadBalancerHealthsResponse listLoadBalancerHealths(ListLoadBalancerHealthsRequest request)
Description copied from interface:LoadBalancer
Lists the summary health statuses for all load balancers in the specified compartment.- Specified by:
listLoadBalancerHealths
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLoadBalancers
public ListLoadBalancersResponse listLoadBalancers(ListLoadBalancersRequest request)
Description copied from interface:LoadBalancer
Lists all load balancers in the specified compartment.- Specified by:
listLoadBalancers
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPathRouteSets
public ListPathRouteSetsResponse listPathRouteSets(ListPathRouteSetsRequest request)
Description copied from interface:LoadBalancer
Lists all path route sets associated with the specified load balancer.- Specified by:
listPathRouteSets
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPolicies
public ListPoliciesResponse listPolicies(ListPoliciesRequest request)
Description copied from interface:LoadBalancer
Lists the available load balancer policies.- Specified by:
listPolicies
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProtocols
public ListProtocolsResponse listProtocols(ListProtocolsRequest request)
Description copied from interface:LoadBalancer
Lists all supported traffic protocols.- Specified by:
listProtocols
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRoutingPolicies
public ListRoutingPoliciesResponse listRoutingPolicies(ListRoutingPoliciesRequest request)
Description copied from interface:LoadBalancer
Lists all routing policies associated with the specified load balancer.- Specified by:
listRoutingPolicies
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRuleSets
public ListRuleSetsResponse listRuleSets(ListRuleSetsRequest request)
Description copied from interface:LoadBalancer
Lists all rule sets associated with the specified load balancer.- Specified by:
listRuleSets
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSSLCipherSuites
public ListSSLCipherSuitesResponse listSSLCipherSuites(ListSSLCipherSuitesRequest request)
Description copied from interface:LoadBalancer
Lists all SSL cipher suites associated with the specified load balancer.- Specified by:
listSSLCipherSuites
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listShapes
public ListShapesResponse listShapes(ListShapesRequest request)
Description copied from interface:LoadBalancer
Lists the valid load balancer shapes.- Specified by:
listShapes
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:LoadBalancer
Lists the work requests for a given load balancer.- Specified by:
listWorkRequests
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBackend
public UpdateBackendResponse updateBackend(UpdateBackendRequest request)
Description copied from interface:LoadBalancer
Updates the configuration of a backend server within the specified backend set.- Specified by:
updateBackend
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBackendSet
public UpdateBackendSetResponse updateBackendSet(UpdateBackendSetRequest request)
Description copied from interface:LoadBalancer
Updates a backend set.- Specified by:
updateBackendSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateHealthChecker
public UpdateHealthCheckerResponse updateHealthChecker(UpdateHealthCheckerRequest request)
Description copied from interface:LoadBalancer
Updates the health check policy for a given load balancer and backend set.- Specified by:
updateHealthChecker
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateHostname
public UpdateHostnameResponse updateHostname(UpdateHostnameRequest request)
Description copied from interface:LoadBalancer
Overwrites an existing hostname resource on the specified load balancer.Use this operation to change a virtual hostname.
- Specified by:
updateHostname
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateListener
public UpdateListenerResponse updateListener(UpdateListenerRequest request)
Description copied from interface:LoadBalancer
Updates a listener for a given load balancer.- Specified by:
updateListener
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLoadBalancer
public UpdateLoadBalancerResponse updateLoadBalancer(UpdateLoadBalancerRequest request)
Description copied from interface:LoadBalancer
Updates a load balancer’s configuration.- Specified by:
updateLoadBalancer
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLoadBalancerShape
public UpdateLoadBalancerShapeResponse updateLoadBalancerShape(UpdateLoadBalancerShapeRequest request)
Description copied from interface:LoadBalancer
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.
- Specified by:
updateLoadBalancerShape
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateNetworkSecurityGroups
public UpdateNetworkSecurityGroupsResponse updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request)
Description copied from interface:LoadBalancer
Updates the network security groups associated with the specified load balancer.- Specified by:
updateNetworkSecurityGroups
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePathRouteSet
public UpdatePathRouteSetResponse updatePathRouteSet(UpdatePathRouteSetRequest request)
Description copied from interface:LoadBalancer
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.- Specified by:
updatePathRouteSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRoutingPolicy
public UpdateRoutingPolicyResponse updateRoutingPolicy(UpdateRoutingPolicyRequest request)
Description copied from interface:LoadBalancer
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.
- Specified by:
updateRoutingPolicy
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRuleSet
public UpdateRuleSetResponse updateRuleSet(UpdateRuleSetRequest request)
Description copied from interface:LoadBalancer
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.
- Specified by:
updateRuleSet
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSSLCipherSuite
public UpdateSSLCipherSuiteResponse updateSSLCipherSuite(UpdateSSLCipherSuiteRequest request)
Description copied from interface:LoadBalancer
Updates an existing SSL cipher suite for the specified load balancer.- Specified by:
updateSSLCipherSuite
in interfaceLoadBalancer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public LoadBalancerWaiters getWaiters()
Description copied from interface:LoadBalancer
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceLoadBalancer
- Returns:
- The service waiters.
-
getPaginators
public LoadBalancerPaginators getPaginators()
Description copied from interface:LoadBalancer
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.- Specified by:
getPaginators
in interfaceLoadBalancer
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-