@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class CreateVnicDetails extends Object
Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
Note: Objects should always be created or deserialized using the CreateVnicDetails.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 CreateVnicDetails.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 |
CreateVnicDetails.Builder |
| Constructor and Description |
|---|
CreateVnicDetails(Boolean assignPublicIp,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String hostnameLabel,
List<String> nsgIds,
String privateIp,
Boolean skipSourceDestCheck,
String subnetId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateVnicDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
Boolean |
getAssignPublicIp()
Whether the VNIC should be assigned a public IP address.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name for the VNIC.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getHostnameLabel()
The hostname for the VNIC’s primary private IP.
|
List<String> |
getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
|
String |
getPrivateIp()
A private IP address of your choice to assign to the VNIC.
|
Boolean |
getSkipSourceDestCheck()
Whether the source/destination check is disabled on the VNIC.
|
String |
getSubnetId()
The OCID of the subnet to create the VNIC in.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"assignPublicIp","definedTags","displayName","freeformTags","hostnameLabel","nsgIds","privateIp","skipSourceDestCheck","subnetId"}) @Deprecated public CreateVnicDetails(Boolean assignPublicIp, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String hostnameLabel, List<String> nsgIds, String privateIp, Boolean skipSourceDestCheck, String subnetId)
public static CreateVnicDetails.Builder builder()
Create a new builder.
public Boolean getAssignPublicIp()
Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.
Note:* This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.
Note:* There’s a limit to the number of PublicIp a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.
Example: false
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 String getDisplayName()
A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
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 String getHostnameLabel()
The hostname for the VNIC’s primary private IP. Used for DNS. The value is the hostname portion of the primary private IP’s fully qualified domain name (FQDN) (for example, bminstance-1 in FQDN bminstance-1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. The value appears in the Vnic object and also the PrivateIp object returned by listPrivateIps and getPrivateIp.
For more information, see DNS in Your Virtual Cloud Network.
When launching an instance, use this hostnameLabel instead of the deprecated hostnameLabel in launchInstanceDetails. If you provide both, the values must match.
Example: bminstance-1
public List<String> getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.
public String getPrivateIp()
A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC’s primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by listPrivateIps and getPrivateIp.
Example: 10.0.3.3
public Boolean getSkipSourceDestCheck()
Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.
Example: true
public String getSubnetId()
The OCID of the subnet to create the VNIC in. When launching an instance, use this subnetId instead of the deprecated subnetId in launchInstanceDetails. At least one of them is required; if you provide both, the values must match.
Copyright © 2016–2020. All rights reserved.