@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public final class LoadBalancer extends Object
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.
For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.
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 __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(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.
|
Constructor and Description |
---|
LoadBalancer(String id,
String compartmentId,
String displayName,
LoadBalancer.LifecycleState lifecycleState,
Date timeCreated,
List<IpAddress> ipAddresses,
String shapeName,
Boolean isPrivate,
List<String> subnetIds,
Map<String,Listener> listeners,
Map<String,Hostname> hostnames,
Map<String,Certificate> certificates,
Map<String,BackendSet> backendSets,
Map<String,PathRouteSet> pathRouteSets,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,RuleSet> ruleSets)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static LoadBalancer.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
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() |
Map<String,PathRouteSet> |
getPathRouteSets() |
Map<String,RuleSet> |
getRuleSets() |
String |
getShapeName()
A template that determines the total pre-provisioned bandwidth (ingress plus egress).
|
List<String> |
getSubnetIds()
An array of subnet OCIDs.
|
Date |
getTimeCreated()
The date and time the load balancer was created, in the format defined by RFC3339.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","displayName","lifecycleState","timeCreated","ipAddresses","shapeName","isPrivate","subnetIds","listeners","hostnames","certificates","backendSets","pathRouteSets","freeformTags","definedTags","ruleSets"}) @Deprecated public LoadBalancer(String id, String compartmentId, String displayName, LoadBalancer.LifecycleState lifecycleState, Date timeCreated, List<IpAddress> ipAddresses, String shapeName, Boolean isPrivate, List<String> subnetIds, Map<String,Listener> listeners, Map<String,Hostname> hostnames, Map<String,Certificate> certificates, Map<String,BackendSet> backendSets, Map<String,PathRouteSet> pathRouteSets, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,RuleSet> ruleSets)
public static LoadBalancer.Builder builder()
Create a new builder.
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 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. For more information about public and private load balancers, see How Load Balancing Works.
Example: true
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\"}}
Copyright © 2016–2019. All rights reserved.