@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Vnic extends Object
A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a primary VNIC that is automatically created and attached during launch. You can add secondary VNICs to an instance after it’s launched. For more information, see Virtual Network Interface Cards (VNICs).
Each VNIC has a primary private IP that is automatically assigned during launch. You can add secondary private IPs to a VNIC after it’s created. For more information, see createPrivateIp
and IP Addresses.
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.
Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the Vnic.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 Vnic.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 |
Vnic.Builder |
static class |
Vnic.LifecycleState
The current state of the VNIC.
|
Constructor and Description |
---|
Vnic(String availabilityDomain,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String hostnameLabel,
String id,
Boolean isPrimary,
Vnic.LifecycleState lifecycleState,
String macAddress,
String privateIp,
String publicIp,
Boolean skipSourceDestCheck,
String subnetId,
Date timeCreated)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Vnic.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getAvailabilityDomain()
The VNIC’s availability domain.
|
String |
getCompartmentId()
The OCID of the compartment containing the VNIC.
|
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.
|
String |
getHostnameLabel()
The hostname for the VNIC’s primary private IP.
|
String |
getId()
The OCID of the VNIC.
|
Boolean |
getIsPrimary()
Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch).
|
Vnic.LifecycleState |
getLifecycleState()
The current state of the VNIC.
|
String |
getMacAddress()
The MAC address of the VNIC.
|
String |
getPrivateIp()
The private IP address of the primary
privateIp object on the VNIC. |
String |
getPublicIp()
The public IP address of the VNIC, if one is assigned.
|
Boolean |
getSkipSourceDestCheck()
Whether the source/destination check is disabled on the VNIC.
|
String |
getSubnetId()
The OCID of the subnet the VNIC is in.
|
Date |
getTimeCreated()
The date and time the VNIC was created, in the format defined by RFC3339.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"availabilityDomain","compartmentId","definedTags","displayName","freeformTags","hostnameLabel","id","isPrimary","lifecycleState","macAddress","privateIp","publicIp","skipSourceDestCheck","subnetId","timeCreated"}) @Deprecated public Vnic(String availabilityDomain, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String hostnameLabel, String id, Boolean isPrimary, Vnic.LifecycleState lifecycleState, String macAddress, String privateIp, String publicIp, Boolean skipSourceDestCheck, String subnetId, Date timeCreated)
public static Vnic.Builder builder()
Create a new builder.
public String getAvailabilityDomain()
The VNIC’s availability domain.
Example: Uocm:PHX-AD-1
public String getCompartmentId()
The OCID of the compartment containing the VNIC.
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. 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.
For more information, see DNS in Your Virtual Cloud Network.
Example: bminstance-1
public String getId()
The OCID of the VNIC.
public Boolean getIsPrimary()
Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch).
public Vnic.LifecycleState getLifecycleState()
The current state of the VNIC.
public String getMacAddress()
The MAC address of the VNIC.
Example: 00:00:17:B6:4D:DD
public String getPrivateIp()
The private IP address of the primary privateIp
object on the VNIC. The address is within the CIDR of the VNIC’s subnet.
Example: 10.0.3.3
public String getPublicIp()
The public IP address of the VNIC, if one is assigned.
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 the VNIC is in.
public Date getTimeCreated()
The date and time the VNIC was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
Copyright © 2016–2019. All rights reserved.