@Generated(value="OracleSDKGenerator",
comments="API Version: 20170115")
public final class LoadBalancer
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The properties that define a load balancer. For more information, see Managing a Load Balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
For information about endpoints and signing API requests, see [About the
API](https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about
available SDKs and tools, see [SDKS and Other
Tools](https://docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).
Note: Objects should always be created or deserialized using the LoadBalancer.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the LoadBalancer.Builder, which maintain a
set of all explicitly set fields called LoadBalancer.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
LoadBalancer.Builder |
static class |
LoadBalancer.LifecycleState
The current state of the load balancer.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
LoadBalancer(String id,
String compartmentId,
String displayName,
LoadBalancer.LifecycleState lifecycleState,
Date timeCreated,
List<IpAddress> ipAddresses,
String shapeName,
ShapeDetails shapeDetails,
Boolean isPrivate,
List<String> subnetIds,
List<String> networkSecurityGroupIds,
Map<String,Listener> listeners,
Map<String,Hostname> hostnames,
Map<String,SSLCipherSuite> sslCipherSuites,
Map<String,Certificate> certificates,
Map<String,BackendSet> backendSets,
Map<String,PathRouteSet> pathRouteSets,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
Map<String,RuleSet> ruleSets,
Map<String,RoutingPolicy> routingPolicies)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static LoadBalancer.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Map<String,BackendSet> |
getBackendSets() |
Map<String,Certificate> |
getCertificates() |
String |
getCompartmentId()
The OCID of the
compartment containing the load balancer.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Map<String,Hostname> |
getHostnames() |
String |
getId()
The OCID of the
load balancer.
|
List<IpAddress> |
getIpAddresses()
An array of IP addresses.
|
Boolean |
getIsPrivate()
Whether the load balancer has a VCN-local (private) IP address.
|
LoadBalancer.LifecycleState |
getLifecycleState()
The current state of the load balancer.
|
Map<String,Listener> |
getListeners() |
List<String> |
getNetworkSecurityGroupIds()
An array of NSG
OCIDs associated
with the load balancer.
|
Map<String,PathRouteSet> |
getPathRouteSets() |
Map<String,RoutingPolicy> |
getRoutingPolicies() |
Map<String,RuleSet> |
getRuleSets() |
ShapeDetails |
getShapeDetails() |
String |
getShapeName()
A template that determines the total pre-provisioned bandwidth (ingress plus egress).
|
Map<String,SSLCipherSuite> |
getSslCipherSuites() |
List<String> |
getSubnetIds()
An array of subnet
OCIDs.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the load balancer was created, in the format defined by RFC3339.
|
int |
hashCode() |
LoadBalancer.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","displayName","lifecycleState","timeCreated","ipAddresses","shapeName","shapeDetails","isPrivate","subnetIds","networkSecurityGroupIds","listeners","hostnames","sslCipherSuites","certificates","backendSets","pathRouteSets","freeformTags","definedTags","systemTags","ruleSets","routingPolicies"}) public LoadBalancer(String id, String compartmentId, String displayName, LoadBalancer.LifecycleState lifecycleState, Date timeCreated, List<IpAddress> ipAddresses, String shapeName, ShapeDetails shapeDetails, Boolean isPrivate, List<String> subnetIds, List<String> networkSecurityGroupIds, Map<String,Listener> listeners, Map<String,Hostname> hostnames, Map<String,SSLCipherSuite> sslCipherSuites, Map<String,Certificate> certificates, Map<String,BackendSet> backendSets, Map<String,PathRouteSet> pathRouteSets, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Map<String,RuleSet> ruleSets, Map<String,RoutingPolicy> routingPolicies)
public static LoadBalancer.Builder builder()
Create a new builder.
public LoadBalancer.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment containing the load balancer.
public String getDisplayName()
A user-friendly name. It does not have to be unique, and it is changeable.
Example: example_load_balancer
public LoadBalancer.LifecycleState getLifecycleState()
The current state of the load balancer.
public Date getTimeCreated()
The date and time the load balancer was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public String getShapeName()
A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get
a list of available shapes, use the listShapes
operation.
Example: 100Mbps
public ShapeDetails getShapeDetails()
public Boolean getIsPrivate()
Whether the load balancer has a VCN-local (private) IP address.
If "true", the service assigns a private IP address to the load balancer.
If "false", the service assigns a public IP address to the load balancer.
A public load balancer is accessible from the internet, depending on your VCN's [security list rules](https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
Example: true
public List<String> getNetworkSecurityGroupIds()
An array of NSG OCIDs associated with the load balancer.
During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
The benefits of associating the load balancer with NSGs include:
NSGs define network security rules to govern ingress and egress traffic for the load balancer.
The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access.
Example: ["ocid1.nsg.oc1.phx.unique_ID"]
public Map<String,SSLCipherSuite> getSslCipherSuites()
public Map<String,Certificate> getCertificates()
public Map<String,BackendSet> getBackendSets()
public Map<String,PathRouteSet> getPathRouteSets()
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public Map<String,RoutingPolicy> getRoutingPolicies()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2023. All rights reserved.