@Generated(value="OracleSDKGenerator",
comments="API Version: 20200501")
public final class CreateNetworkLoadBalancerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The properties that define a network load balancer. For more information, see Managing a network load balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator. If you are an administrator who writes policies to give users access, then 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 CreateNetworkLoadBalancerDetails.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 CreateNetworkLoadBalancerDetails.Builder, which maintain a
set of all explicitly set fields called CreateNetworkLoadBalancerDetails.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 |
CreateNetworkLoadBalancerDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateNetworkLoadBalancerDetails(String compartmentId,
String displayName,
Boolean isPreserveSourceDestination,
Boolean isSymmetricHashEnabled,
List<ReservedIP> reservedIps,
Boolean isPrivate,
String subnetId,
List<String> networkSecurityGroupIds,
NlbIpVersion nlbIpVersion,
String subnetIpv6Cidr,
String assignedPrivateIpv4,
String assignedIpv6,
Map<String,ListenerDetails> listeners,
Map<String,BackendSetDetails> backendSets,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> securityAttributes)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateNetworkLoadBalancerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAssignedIpv6()
IPv6 address to be assigned to the network load balancer being created.
|
String |
getAssignedPrivateIpv4()
Private IP address to be assigned to the network load balancer being created.
|
Map<String,BackendSetDetails> |
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()
Network load balancer identifier, which can be renamed.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type, or scope.
|
Boolean |
getIsPreserveSourceDestination()
This parameter can be enabled only if backends are compute OCIDs.
|
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.
|
Map<String,ListenerDetails> |
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.
|
List<ReservedIP> |
getReservedIps()
An array of reserved Ips.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
ZPR tags for this resource.
|
String |
getSubnetId()
The subnet in which the network load balancer is spawned
OCIDs.
|
String |
getSubnetIpv6Cidr()
IPv6 subnet prefix selection.
|
int |
hashCode() |
CreateNetworkLoadBalancerDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","displayName","isPreserveSourceDestination","isSymmetricHashEnabled","reservedIps","isPrivate","subnetId","networkSecurityGroupIds","nlbIpVersion","subnetIpv6Cidr","assignedPrivateIpv4","assignedIpv6","listeners","backendSets","freeformTags","definedTags","securityAttributes"}) public CreateNetworkLoadBalancerDetails(String compartmentId, String displayName, Boolean isPreserveSourceDestination, Boolean isSymmetricHashEnabled, List<ReservedIP> reservedIps, Boolean isPrivate, String subnetId, List<String> networkSecurityGroupIds, NlbIpVersion nlbIpVersion, String subnetIpv6Cidr, String assignedPrivateIpv4, String assignedIpv6, Map<String,ListenerDetails> listeners, Map<String,BackendSetDetails> backendSets, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes)
public static CreateNetworkLoadBalancerDetails.Builder builder()
Create a new builder.
public CreateNetworkLoadBalancerDetails.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment containing the network load balancer.
public String getDisplayName()
Network load balancer identifier, which can be renamed.
public Boolean getIsPreserveSourceDestination()
This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
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 List<ReservedIP> getReservedIps()
An array of reserved Ips.
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 on the [security list rules](https://docs.cloud.oracle.com/Content/network/Concepts/securitylists.htm) for your virtual cloud 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 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 NlbIpVersion getNlbIpVersion()
IP version associated with the NLB.
public String getSubnetIpv6Cidr()
IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.
public String getAssignedPrivateIpv4()
Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: “10.0.0.1”
public String getAssignedIpv6()
IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: “2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789”
public Map<String,ListenerDetails> getListeners()
Listeners associated with the network load balancer.
public Map<String,BackendSetDetails> getBackendSets()
Backend sets associated with the network load balancer.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
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 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.