Package com.oracle.bmc.core.model

Class VnicAttachment

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.core.model.VnicAttachment

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class VnicAttachment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Represents an attachment between a VNIC and an instance.

For more information, see Virtual Network Interface Cards (VNICs).

*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 VnicAttachment.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 VnicAttachment.Builder, which maintain a set of all explicitly set fields called VnicAttachment.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VnicAttachment.Builder
static class	VnicAttachment.LifecycleState	The current state of the VNIC attachment.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
VnicAttachment(String availabilityDomain, String compartmentId, String displayName, String id, String instanceId, VnicAttachment.LifecycleState lifecycleState, Integer nicIndex, String subnetId, String vlanId, Date timeCreated, Integer vlanTag, String vnicId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static VnicAttachment.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAvailabilityDomain()	The availability domain of the instance.
String	getCompartmentId()	The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.
String	getDisplayName()	A user-friendly name.
String	getId()	The OCID of the VNIC attachment.
String	getInstanceId()	The OCID of the instance.
VnicAttachment.LifecycleState	getLifecycleState()	The current state of the VNIC attachment.
Integer	getNicIndex()	Which physical network interface card (NIC) the VNIC uses.
String	getSubnetId()	The OCID of the subnet to create the VNIC in.
Date	getTimeCreated()	The date and time the VNIC attachment was created, in the format defined by RFC3339.
String	getVlanId()	The OCID of the VLAN to create the VNIC in.
Integer	getVlanTag()	The Oracle-assigned VLAN tag of the attached VNIC.
String	getVnicId()	The OCID of the VNIC.
int	hashCode()
VnicAttachment.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

VnicAttachment

@Deprecated
@ConstructorProperties({"availabilityDomain","compartmentId","displayName","id","instanceId","lifecycleState","nicIndex","subnetId","vlanId","timeCreated","vlanTag","vnicId"})
public VnicAttachment(String availabilityDomain,
                      String compartmentId,
                      String displayName,
                      String id,
                      String instanceId,
                      VnicAttachment.LifecycleState lifecycleState,
                      Integer nicIndex,
                      String subnetId,
                      String vlanId,
                      Date timeCreated,
                      Integer vlanTag,
                      String vnicId)

Deprecated.

Method Detail

builder

public static VnicAttachment.Builder builder()

Create a new builder.

toBuilder

public VnicAttachment.Builder toBuilder()

getAvailabilityDomain

public String getAvailabilityDomain()

The availability domain of the instance.

Example: Uocm:PHX-AD-1

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.

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

getId

public String getId()

The OCID of the VNIC attachment.

Returns:

the value

getInstanceId

public String getInstanceId()

The OCID of the instance.

Returns:

the value

getLifecycleState

public VnicAttachment.LifecycleState getLifecycleState()

The current state of the VNIC attachment.

Returns:

the value

getNicIndex

public Integer getNicIndex()

Which physical network interface card (NIC) the VNIC uses.

Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see Virtual Network Interface Cards (VNICs).

Returns:

the value

getSubnetId

public String getSubnetId()

The OCID of the subnet to create the VNIC in.

Returns:

the value

getVlanId

public String getVlanId()

The OCID of the VLAN to create the VNIC in.

Creating the VNIC in a VLAN (instead of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. See Vlan.

An error is returned if the instance already has a VNIC attached to it from this VLAN.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the VNIC attachment was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getVlanTag

public Integer getVlanTag()

The Oracle-assigned VLAN tag of the attached VNIC.

Available after the attachment process is complete.

However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, the vlanTag value is instead the value of the vlanTag attribute for the VLAN. See Vlan.

Example: 0

Returns:

the value

getVnicId

public String getVnicId()

The OCID of the VNIC.

Available after the attachment process is complete.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.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 com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel