@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public interface LoadBalancer extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
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.
|
CreateRuleSetResponse |
createRuleSet(CreateRuleSetRequest request)
Creates a new rule set associated with the specified load balancer.
|
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.
|
DeleteRuleSetResponse |
deleteRuleSet(DeleteRuleSetRequest request)
Deletes a rule set from the specified 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.
|
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.
|
GetRuleSetResponse |
getRuleSet(GetRuleSetRequest request)
Gets the specified set of rules.
|
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.
|
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.
|
ListRuleSetsResponse |
listRuleSets(ListRuleSetsRequest request)
Lists all rule sets associated with the specified load balancer.
|
ListShapesResponse |
listShapes(ListShapesRequest request)
Lists the valid load balancer shapes.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests for a given load balancer.
|
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.
|
UpdatePathRouteSetResponse |
updatePathRouteSet(UpdatePathRouteSetRequest request)
Overwrites an existing path route set on the specified load balancer.
|
UpdateRuleSetResponse |
updateRuleSet(UpdateRuleSetRequest request)
Overwrites an existing set of rules on the specified load balancer.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.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.
region
- The region of the service.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 call setEndpoint
.
regionId
- The public region ID.CreateBackendResponse createBackend(CreateBackendRequest request)
Adds a backend server to a backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateBackendSetResponse createBackendSet(CreateBackendSetRequest request)
Adds a backend set to a load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Creates an asynchronous request to add an SSL certificate bundle.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateHostnameResponse createHostname(CreateHostnameRequest request)
Adds a hostname resource to the specified load balancer. For more information, see Managing Request Routing.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateListenerResponse createListener(CreateListenerRequest request)
Adds a listener to a load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
You must specify a display name for the load balancer. It does not have to be unique, and you can change it.
For information about Availability Domains, see Regions and Availability Domains. To get a list of Availability Domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers.
After you send your request, the new object’s state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING.
When you create a load balancer, the system assigns an IP address. To get the IP address, use the getLoadBalancer
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreatePathRouteSetResponse createPathRouteSet(CreatePathRouteSetRequest request)
Adds a path route set to a load balancer. For more information, see Managing Request Routing.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateRuleSetResponse createRuleSet(CreateRuleSetRequest request)
Creates a new rule set associated with the specified load balancer. For more information, see Managing Rule Sets.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteBackendResponse deleteBackend(DeleteBackendRequest request)
Removes a backend server from a given load balancer and backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL certificate bundle from a load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteHostnameResponse deleteHostname(DeleteHostnameRequest request)
Deletes a hostname resource from the specified load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteListenerResponse deleteListener(DeleteListenerRequest request)
Deletes a listener from a load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest request)
Stops a load balancer and removes it from service.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBackendResponse getBackend(GetBackendRequest request)
Gets the specified backend server’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBackendHealthResponse getBackendHealth(GetBackendHealthRequest request)
Gets the current health status of the specified backend server.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBackendSetResponse getBackendSet(GetBackendSetRequest request)
Gets the specified backend set’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBackendSetHealthResponse getBackendSetHealth(GetBackendSetHealthRequest request)
Gets the health status for the specified backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetHealthCheckerResponse getHealthChecker(GetHealthCheckerRequest request)
Gets the health check policy information for a given load balancer and backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetHostnameResponse getHostname(GetHostnameRequest request)
Gets the specified hostname resource’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetLoadBalancerResponse getLoadBalancer(GetLoadBalancerRequest request)
Gets the specified load balancer’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetLoadBalancerHealthResponse getLoadBalancerHealth(GetLoadBalancerHealthRequest request)
Gets the health status for the specified load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetPathRouteSetResponse getPathRouteSet(GetPathRouteSetRequest request)
Gets the specified path route set’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetRuleSetResponse getRuleSet(GetRuleSetRequest request)
Gets the specified set of rules.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListBackendSetsResponse listBackendSets(ListBackendSetsRequest request)
Lists all backend sets associated with a given load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListBackendsResponse listBackends(ListBackendsRequest request)
Lists the backend servers for a given load balancer and backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Lists all SSL certificates bundles associated with a given load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListHostnamesResponse listHostnames(ListHostnamesRequest request)
Lists all hostname resources associated with the specified load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListLoadBalancerHealthsResponse listLoadBalancerHealths(ListLoadBalancerHealthsRequest request)
Lists the summary health statuses for all load balancers in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListLoadBalancersResponse listLoadBalancers(ListLoadBalancersRequest request)
Lists all load balancers in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListPathRouteSetsResponse listPathRouteSets(ListPathRouteSetsRequest request)
Lists all path route sets associated with the specified load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListPoliciesResponse listPolicies(ListPoliciesRequest request)
Lists the available load balancer policies.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListProtocolsResponse listProtocols(ListProtocolsRequest request)
Lists all supported traffic protocols.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListRuleSetsResponse listRuleSets(ListRuleSetsRequest request)
Lists all rule sets associated with the specified load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListShapesResponse listShapes(ListShapesRequest request)
Lists the valid load balancer shapes.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests for a given load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateBackendResponse updateBackend(UpdateBackendRequest request)
Updates the configuration of a backend server within the specified backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateBackendSetResponse updateBackendSet(UpdateBackendSetRequest request)
Updates a backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateHealthCheckerResponse updateHealthChecker(UpdateHealthCheckerRequest request)
Updates the health check policy for a given load balancer and backend set.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateHostnameResponse updateHostname(UpdateHostnameRequest request)
Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateListenerResponse updateListener(UpdateListenerRequest request)
Updates a listener for a given load balancer.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateLoadBalancerResponse updateLoadBalancer(UpdateLoadBalancerRequest request)
Updates a load balancer’s configuration.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.LoadBalancerWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2019. All rights reserved.