VifAttachmentContext (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.VifAttachmentContext

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class VifAttachmentContext
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VifAttachmentContext.Builder
Builder class for VifAttachmentContext.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VifAttachmentContext.Builder` Builder class for `VifAttachmentContext`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`static java.lang.String`	`VIF_TYPE_CHILD`
`static java.lang.String`	`VIF_TYPE_INDEPENDENT`
`static java.lang.String`	`VIF_TYPE_PARENT`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`VifAttachmentContext()` Default constructor.
`protected`	`VifAttachmentContext(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static VifAttachmentContext`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static VifAttachmentContext`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAllocateAddresses()` Possible values are: `AttachmentContext.ALLOCATE_ADDRESSES_IPPOOL` `AttachmentContext.ALLOCATE_ADDRESSES_MACPOOL` `AttachmentContext.ALLOCATE_ADDRESSES_BOTH` `AttachmentContext.ALLOCATE_ADDRESSES_NONE` `AttachmentContext.ALLOCATE_ADDRESSES_DHCP` `AttachmentContext.ALLOCATE_ADDRESSES_DHCPV6` `AttachmentContext.ALLOCATE_ADDRESSES_SLAAC` A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
`java.lang.String`	`getAppId()` An application ID used to identify / look up a child VIF behind a parent VIF.
`AttachedInterface`	`getBmsInterfaceConfig()`
`java.lang.String`	`getParentVifId()` VIF ID of the parent VIF if vif_type is CHILD
`java.lang.String`	`getResourceType()` Used to identify which concrete class it is The value of this property is automatically populated to `"VifAttachmentContext"`.
`java.lang.Long`	`getTrafficTag()` Current we use VLAN id as the traffic tag.
`java.lang.String`	`getTransportNodeUuid()` Only effective when vif_type is INDEPENDENT.
`java.lang.String`	`getVifType()` Possible values are: `VIF_TYPE_PARENT` `VIF_TYPE_CHILD` `VIF_TYPE_INDEPENDENT` Type of the VIF attached to logical port
`int`	`hashCode()`
`void`	`setAllocateAddresses(java.lang.String allocateAddresses)` Possible values are: `AttachmentContext.ALLOCATE_ADDRESSES_IPPOOL` `AttachmentContext.ALLOCATE_ADDRESSES_MACPOOL` `AttachmentContext.ALLOCATE_ADDRESSES_BOTH` `AttachmentContext.ALLOCATE_ADDRESSES_NONE` `AttachmentContext.ALLOCATE_ADDRESSES_DHCP` `AttachmentContext.ALLOCATE_ADDRESSES_DHCPV6` `AttachmentContext.ALLOCATE_ADDRESSES_SLAAC` A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
`void`	`setAppId(java.lang.String appId)` An application ID used to identify / look up a child VIF behind a parent VIF.
`void`	`setBmsInterfaceConfig(AttachedInterface bmsInterfaceConfig)`
`void`	`setParentVifId(java.lang.String parentVifId)` VIF ID of the parent VIF if vif_type is CHILD
`void`	`setTrafficTag(java.lang.Long trafficTag)` Current we use VLAN id as the traffic tag.
`void`	`setTransportNodeUuid(java.lang.String transportNodeUuid)` Only effective when vif_type is INDEPENDENT.
`void`	`setVifType(java.lang.String vifType)` Possible values are: `VIF_TYPE_PARENT` `VIF_TYPE_CHILD` `VIF_TYPE_INDEPENDENT` Type of the VIF attached to logical port
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - VIF_TYPE_PARENT
```
public static final java.lang.String VIF_TYPE_PARENT
```
    See Also:
    
    Constant Field Values
  - VIF_TYPE_CHILD
```
public static final java.lang.String VIF_TYPE_CHILD
```
    See Also:
    
    Constant Field Values
  - VIF_TYPE_INDEPENDENT
```
public static final java.lang.String VIF_TYPE_INDEPENDENT
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - VifAttachmentContext
```
public VifAttachmentContext()
```
    Default constructor.
  - VifAttachmentContext
```
protected VifAttachmentContext(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAppId
```
public java.lang.String getAppId()
```
    An application ID used to identify / look up a child VIF behind a parent VIF. Only effective when vif_type is CHILD.
    
    Returns:
    
    The current value of the property.
  - setAppId
```
public void setAppId(java.lang.String appId)
```
    An application ID used to identify / look up a child VIF behind a parent VIF. Only effective when vif_type is CHILD.
    
    Parameters:
    
    appId - New value for the property.
  - getBmsInterfaceConfig
```
public AttachedInterface getBmsInterfaceConfig()
```
    Returns:
    
    The current value of the property.
  - setBmsInterfaceConfig
```
public void setBmsInterfaceConfig(AttachedInterface bmsInterfaceConfig)
```
    Parameters:
    
    bmsInterfaceConfig - New value for the property.
  - getParentVifId
```
public java.lang.String getParentVifId()
```
    VIF ID of the parent VIF if vif_type is CHILD
    
    Returns:
    
    The current value of the property.
  - setParentVifId
```
public void setParentVifId(java.lang.String parentVifId)
```
    VIF ID of the parent VIF if vif_type is CHILD
    
    Parameters:
    
    parentVifId - New value for the property.
  - getTrafficTag
```
public java.lang.Long getTrafficTag()
```
    Current we use VLAN id as the traffic tag. Only effective when vif_type is CHILD. Each logical port inside a container must have a unique traffic tag. If the traffic_tag is not unique, no error is generated, but traffic will not be delivered to any port with a non-unique tag. format: int32
    
    Returns:
    
    The current value of the property.
  - setTrafficTag
```
public void setTrafficTag(java.lang.Long trafficTag)
```
    Current we use VLAN id as the traffic tag. Only effective when vif_type is CHILD. Each logical port inside a container must have a unique traffic tag. If the traffic_tag is not unique, no error is generated, but traffic will not be delivered to any port with a non-unique tag. format: int32
    
    Parameters:
    
    trafficTag - New value for the property.
  - getTransportNodeUuid
```
public java.lang.String getTransportNodeUuid()
```
    Only effective when vif_type is INDEPENDENT. Each logical port inside a bare metal server or container must have a transport node UUID. We use transport node ID as transport node UUID.
    
    Returns:
    
    The current value of the property.
  - setTransportNodeUuid
```
public void setTransportNodeUuid(java.lang.String transportNodeUuid)
```
    Only effective when vif_type is INDEPENDENT. Each logical port inside a bare metal server or container must have a transport node UUID. We use transport node ID as transport node UUID.
    
    Parameters:
    
    transportNodeUuid - New value for the property.
  - getVifType
```
public java.lang.String getVifType()
```
    Possible values are:
    Type of the VIF attached to logical port
    Returns:
    
    The current value of the property.
  - setVifType
```
public void setVifType(java.lang.String vifType)
```
    Possible values are:
    Type of the VIF attached to logical port
    Parameters:
    
    vifType - New value for the property.
  - getAllocateAddresses
```
public java.lang.String getAllocateAddresses()
```
    Possible values are:
    A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
    Returns:
    
    The current value of the property.
  - setAllocateAddresses
```
public void setAllocateAddresses(java.lang.String allocateAddresses)
```
    Possible values are:
    A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
    Parameters:
    
    allocateAddresses - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    Used to identify which concrete class it is The value of this property is automatically populated to "VifAttachmentContext".
    
    Returns:
    
    The current value of the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static VifAttachmentContext _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static VifAttachmentContext _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class VifAttachmentContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

VIF_TYPE_PARENT

VIF_TYPE_CHILD

VIF_TYPE_INDEPENDENT

__dynamicStructureFields

Constructor Detail

VifAttachmentContext

VifAttachmentContext

Method Detail

getAppId

setAppId

getBmsInterfaceConfig

setBmsInterfaceConfig

getParentVifId

setParentVifId

getTrafficTag

setTrafficTag

getTransportNodeUuid

setTransportNodeUuid

getVifType

setVifType

getAllocateAddresses

setAllocateAddresses

getResourceType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2