com.oracle.bmc.vnmonitoring.model

Class CreateVnicDetails

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.vnmonitoring.model.CreateVnicDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CreateVnicDetails
extends ExplicitlySetBmcModel

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 ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateVnicDetails.Builder

Constructor Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
static CreateVnicDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
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.
Map<String,String>	getFreeformTags() Simple key-value pair that is applied without any predefined name, type or scope.
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()
CreateVnicDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVnicDetails

@Deprecated
 @ConstructorProperties(value={"assignPublicIp","definedTags","displayName","freeformTags","hostnameLabel","nsgIds","privateIp","skipSourceDestCheck","subnetId"})
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)

Deprecated.

Method Detail

builder

public static CreateVnicDetails.Builder builder()

Create a new builder.

toBuilder

public CreateVnicDetails.Builder toBuilder()

getAssignPublicIp

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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).

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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).

Example: false

Returns:

the value

getDefinedTags

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"}}

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getFreeformTags

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"}

Returns:

the value

getHostnameLabel

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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

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

Returns:

the value

getNsgIds

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.

Returns:

the value

getPrivateIp

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

Returns:

the value

getSkipSourceDestCheck

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

Returns:

the value

getSubnetId

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel