@Generated(value="OracleSDKGenerator",
comments="API Version: 20200501")
public final class NetworkLoadBalancerSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Network load balancer object to be used for list operations.
Note: Objects should always be created or deserialized using the NetworkLoadBalancerSummary.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 NetworkLoadBalancerSummary.Builder, which maintain a
set of all explicitly set fields called NetworkLoadBalancerSummary.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 |
NetworkLoadBalancerSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
NetworkLoadBalancerSummary(String id,
String compartmentId,
String displayName,
LifecycleState lifecycleState,
String lifecycleDetails,
NlbIpVersion nlbIpVersion,
Date timeCreated,
Date timeUpdated,
List<IpAddress> ipAddresses,
Boolean isPrivate,
Boolean isPreserveSourceDestination,
Boolean isSymmetricHashEnabled,
String subnetId,
List<String> networkSecurityGroupIds,
Map<String,Listener> listeners,
Map<String,BackendSet> backendSets,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> securityAttributes,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static NetworkLoadBalancerSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Map<String,BackendSet> |
getBackendSets()
Backend sets associated with the network load balancer.
|
String |
getCompartmentId()
The OCID of the
compartment containing the network load balancer.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name, which does not have to be unique, and can be changed.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the
network load balancer.
|
List<IpAddress> |
getIpAddresses()
An array of IP addresses.
|
Boolean |
getIsPreserveSourceDestination()
When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load
balancer VNIC.
|
Boolean |
getIsPrivate()
Whether the network load balancer has a virtual cloud network-local (private) IP address.
|
Boolean |
getIsSymmetricHashEnabled()
This can only be enabled when NLB is working in transparent mode with source destination
header preservation enabled.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
LifecycleState |
getLifecycleState()
The current state of the network load balancer.
|
Map<String,Listener> |
getListeners()
Listeners associated with the network load balancer.
|
List<String> |
getNetworkSecurityGroupIds()
An array of network security groups
OCIDs associated
with the network load balancer.
|
NlbIpVersion |
getNlbIpVersion()
IP version associated with the NLB.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
ZPR tags for this resource.
|
String |
getSubnetId()
The subnet in which the network load balancer is spawned
OCIDs.
|
Map<String,Map<String,Object>> |
getSystemTags()
Key-value pair representing system tags’ keys and values scoped to a namespace.
|
Date |
getTimeCreated()
The date and time the network load balancer was created, in the format defined by RFC3339.
|
Date |
getTimeUpdated()
The time the network load balancer was updated.
|
int |
hashCode() |
NetworkLoadBalancerSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","displayName","lifecycleState","lifecycleDetails","nlbIpVersion","timeCreated","timeUpdated","ipAddresses","isPrivate","isPreserveSourceDestination","isSymmetricHashEnabled","subnetId","networkSecurityGroupIds","listeners","backendSets","freeformTags","securityAttributes","definedTags","systemTags"}) public NetworkLoadBalancerSummary(String id, String compartmentId, String displayName, LifecycleState lifecycleState, String lifecycleDetails, NlbIpVersion nlbIpVersion, Date timeCreated, Date timeUpdated, List<IpAddress> ipAddresses, Boolean isPrivate, Boolean isPreserveSourceDestination, Boolean isSymmetricHashEnabled, String subnetId, List<String> networkSecurityGroupIds, Map<String,Listener> listeners, Map<String,BackendSet> backendSets, Map<String,String> freeformTags, Map<String,Map<String,Object>> securityAttributes, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static NetworkLoadBalancerSummary.Builder builder()
Create a new builder.
public NetworkLoadBalancerSummary.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment containing the network load balancer.
public String getDisplayName()
A user-friendly name, which does not have to be unique, and can be changed.
Example: example_load_balancer
public LifecycleState getLifecycleState()
The current state of the network load balancer.
public String getLifecycleDetails()
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
public NlbIpVersion getNlbIpVersion()
IP version associated with the NLB.
public Date getTimeCreated()
The date and time the network load balancer was created, in the format defined by RFC3339.
Example: 2020-05-01T21:10:29.600Z
public Date getTimeUpdated()
The time the network load balancer was updated. An RFC3339 formatted date-time string.
Example: 2020-05-01T22:10:29.600Z
public Boolean getIsPrivate()
Whether the network load balancer has a virtual cloud network-local (private) IP address.
If "true", then the service assigns a private IP address to the network load balancer.
If "false", then the service assigns a public IP address to the network load balancer.
A public network load balancer is accessible from the internet, depending the [security list rules](https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and private network load balancers, see [How Network Load Balancing Works](https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-network-load-balancing-works). This value is true by default.
Example: true
public Boolean getIsPreserveSourceDestination()
When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
public Boolean getIsSymmetricHashEnabled()
This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.
public String getSubnetId()
The subnet in which the network load balancer is spawned OCIDs.
public List<String> getNetworkSecurityGroupIds()
An array of network security groups OCIDs associated with the network load balancer.
During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.
The benefits of associating the network load balancer with network security groups include:
Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.
Example: ["ocid1.nsg.oc1.phx.unique_ID"]
public Map<String,Listener> getListeners()
Listeners associated with the network load balancer.
public Map<String,BackendSet> getBackendSets()
Backend sets associated with the network load balancer.
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>> getSecurityAttributes()
ZPR 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: { "oracle-zpr": { "td": { "value": "42", "mode": "audit" } } }
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()
Key-value pair representing system tags’ keys and values scoped to a namespace. Example:
{"bar-key": "value"}
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–2024. All rights reserved.