PortAttachment (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.PortAttachment

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PortAttachment
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Detail information about port attachment

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PortAttachment.Builder
Builder class for PortAttachment.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ALLOCATE_ADDRESSES_BOTH`
`static java.lang.String`	`ALLOCATE_ADDRESSES_DHCP`
`static java.lang.String`	`ALLOCATE_ADDRESSES_DHCPV6`
`static java.lang.String`	`ALLOCATE_ADDRESSES_IP_POOL`
`static java.lang.String`	`ALLOCATE_ADDRESSES_MAC_POOL`
`static java.lang.String`	`ALLOCATE_ADDRESSES_NONE`
`static java.lang.String`	`ALLOCATE_ADDRESSES_SLAAC`
`static java.lang.String`	`CONTEXT_TYPE_PARENT`
`static java.lang.String`	`HYPERBUS_MODE_DISABLE`
`static java.lang.String`	`HYPERBUS_MODE_ENABLE`
`static java.lang.String`	`TYPE_CHILD`
`static java.lang.String`	`TYPE_INDEPENDENT`
`static java.lang.String`	`TYPE_PARENT`
`static java.lang.String`	`TYPE_STATIC`

Constructor Summary

Constructors
Modifier Constructor and Description

PortAttachment()
Default constructor.

protected PortAttachment(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`PortAttachment()` Default constructor.
`protected`	`PortAttachment(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 PortAttachment`	`_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 PortAttachment`	`_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: `ALLOCATE_ADDRESSES_IP_POOL` `ALLOCATE_ADDRESSES_MAC_POOL` `ALLOCATE_ADDRESSES_BOTH` `ALLOCATE_ADDRESSES_NONE` `ALLOCATE_ADDRESSES_DHCP` `ALLOCATE_ADDRESSES_DHCPV6` `ALLOCATE_ADDRESSES_SLAAC` Indicate how IP will be allocated for the port
`java.lang.String`	`getAppId()` ID used to identify/look up a child attachment behind a parent attachment
`AttachedInterfaceEntry`	`getBmsInterfaceConfig()`
`java.lang.String`	`getContextId()` If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port.
`java.lang.String`	`getContextType()` Possible values are: `CONTEXT_TYPE_PARENT` Set to PARENT when type field is CHILD.
`java.util.List<java.lang.String>`	`getEvpnVlans()` List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode.
`java.lang.String`	`getHyperbusMode()` Possible values are: `HYPERBUS_MODE_ENABLE` `HYPERBUS_MODE_DISABLE` Flag to indicate if hyperbus configuration is required.
`java.lang.String`	`getId()` VIF UUID on NSX Manager.
`java.lang.Long`	`getTrafficTag()` Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case.
`java.lang.String`	`getType()` Possible values are: `TYPE_PARENT` `TYPE_CHILD` `TYPE_INDEPENDENT` `TYPE_STATIC` Type of port attachment.
`int`	`hashCode()`
`void`	`setAllocateAddresses(java.lang.String allocateAddresses)` Possible values are: `ALLOCATE_ADDRESSES_IP_POOL` `ALLOCATE_ADDRESSES_MAC_POOL` `ALLOCATE_ADDRESSES_BOTH` `ALLOCATE_ADDRESSES_NONE` `ALLOCATE_ADDRESSES_DHCP` `ALLOCATE_ADDRESSES_DHCPV6` `ALLOCATE_ADDRESSES_SLAAC` Indicate how IP will be allocated for the port
`void`	`setAppId(java.lang.String appId)` ID used to identify/look up a child attachment behind a parent attachment
`void`	`setBmsInterfaceConfig(AttachedInterfaceEntry bmsInterfaceConfig)`
`void`	`setContextId(java.lang.String contextId)` If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port.
`void`	`setContextType(java.lang.String contextType)` Possible values are: `CONTEXT_TYPE_PARENT` Set to PARENT when type field is CHILD.
`void`	`setEvpnVlans(java.util.List<java.lang.String> evpnVlans)` List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode.
`void`	`setHyperbusMode(java.lang.String hyperbusMode)` Possible values are: `HYPERBUS_MODE_ENABLE` `HYPERBUS_MODE_DISABLE` Flag to indicate if hyperbus configuration is required.
`void`	`setId(java.lang.String id)` VIF UUID on NSX Manager.
`void`	`setTrafficTag(java.lang.Long trafficTag)` Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case.
`void`	`setType(java.lang.String type)` Possible values are: `TYPE_PARENT` `TYPE_CHILD` `TYPE_INDEPENDENT` `TYPE_STATIC` Type of port attachment.
`java.lang.String`	`toString()`

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

- Field Detail
  - ALLOCATE_ADDRESSES_IP_POOL
```
public static final java.lang.String ALLOCATE_ADDRESSES_IP_POOL
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_MAC_POOL
```
public static final java.lang.String ALLOCATE_ADDRESSES_MAC_POOL
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_BOTH
```
public static final java.lang.String ALLOCATE_ADDRESSES_BOTH
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_NONE
```
public static final java.lang.String ALLOCATE_ADDRESSES_NONE
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_DHCP
```
public static final java.lang.String ALLOCATE_ADDRESSES_DHCP
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_DHCPV6
```
public static final java.lang.String ALLOCATE_ADDRESSES_DHCPV6
```
    See Also:
    
    Constant Field Values
  - ALLOCATE_ADDRESSES_SLAAC
```
public static final java.lang.String ALLOCATE_ADDRESSES_SLAAC
```
    See Also:
    
    Constant Field Values
  - CONTEXT_TYPE_PARENT
```
public static final java.lang.String CONTEXT_TYPE_PARENT
```
    See Also:
    
    Constant Field Values
  - HYPERBUS_MODE_ENABLE
```
public static final java.lang.String HYPERBUS_MODE_ENABLE
```
    See Also:
    
    Constant Field Values
  - HYPERBUS_MODE_DISABLE
```
public static final java.lang.String HYPERBUS_MODE_DISABLE
```
    See Also:
    
    Constant Field Values
  - TYPE_PARENT
```
public static final java.lang.String TYPE_PARENT
```
    See Also:
    
    Constant Field Values
  - TYPE_CHILD
```
public static final java.lang.String TYPE_CHILD
```
    See Also:
    
    Constant Field Values
  - TYPE_INDEPENDENT
```
public static final java.lang.String TYPE_INDEPENDENT
```
    See Also:
    
    Constant Field Values
  - TYPE_STATIC
```
public static final java.lang.String TYPE_STATIC
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PortAttachment
```
public PortAttachment()
```
    Default constructor.
  - PortAttachment
```
protected PortAttachment(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAllocateAddresses
```
public java.lang.String getAllocateAddresses()
```
    Possible values are:
    Indicate how IP will be allocated for the port
    Returns:
    
    The current value of the property.
  - setAllocateAddresses
```
public void setAllocateAddresses(java.lang.String allocateAddresses)
```
    Possible values are:
    Indicate how IP will be allocated for the port
    Parameters:
    
    allocateAddresses - New value for the property.
  - getAppId
```
public java.lang.String getAppId()
```
    ID used to identify/look up a child attachment behind a parent attachment
    
    Returns:
    
    The current value of the property.
  - setAppId
```
public void setAppId(java.lang.String appId)
```
    ID used to identify/look up a child attachment behind a parent attachment
    
    Parameters:
    
    appId - New value for the property.
  - getBmsInterfaceConfig
```
public AttachedInterfaceEntry getBmsInterfaceConfig()
```
    Returns:
    
    The current value of the property.
  - setBmsInterfaceConfig
```
public void setBmsInterfaceConfig(AttachedInterfaceEntry bmsInterfaceConfig)
```
    Parameters:
    
    bmsInterfaceConfig - New value for the property.
  - getContextId
```
public java.lang.String getContextId()
```
    If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port. If type is CHILD and the parent port is on a different segment, then this field should be policy path of the parent port. If type is INDEPENDENT/STATIC, then this field should be transport node ID.
    
    Returns:
    
    The current value of the property.
  - setContextId
```
public void setContextId(java.lang.String contextId)
```
    If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port. If type is CHILD and the parent port is on a different segment, then this field should be policy path of the parent port. If type is INDEPENDENT/STATIC, then this field should be transport node ID.
    
    Parameters:
    
    contextId - New value for the property.
  - getContextType
```
public java.lang.String getContextType()
```
    Possible values are:
    - CONTEXT_TYPE_PARENT
    Set to PARENT when type field is CHILD. Read only field. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setContextType
```
public void setContextType(java.lang.String contextType)
```
    Possible values are:
    - CONTEXT_TYPE_PARENT
    Set to PARENT when type field is CHILD. Read only field. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    contextType - New value for the property.
  - getEvpnVlans
```
public java.util.List<java.lang.String> getEvpnVlans()
```
    List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode. Only effective when attachment type is PARENT and the logical-port is attached to vRouter VM.
    
    Returns:
    
    The current value of the property.
  - setEvpnVlans
```
public void setEvpnVlans(java.util.List<java.lang.String> evpnVlans)
```
    List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode. Only effective when attachment type is PARENT and the logical-port is attached to vRouter VM.
    
    Parameters:
    
    evpnVlans - New value for the property.
  - getHyperbusMode
```
public java.lang.String getHyperbusMode()
```
    Possible values are:
    - HYPERBUS_MODE_ENABLE
    - HYPERBUS_MODE_DISABLE
    Flag to indicate if hyperbus configuration is required.
    Returns:
    
    The current value of the property.
  - setHyperbusMode
```
public void setHyperbusMode(java.lang.String hyperbusMode)
```
    Possible values are:
    - HYPERBUS_MODE_ENABLE
    - HYPERBUS_MODE_DISABLE
    Flag to indicate if hyperbus configuration is required.
    Parameters:
    
    hyperbusMode - New value for the property.
  - getId
```
public java.lang.String getId()
```
    VIF UUID on NSX Manager. If the attachement type is PARENT, this property is required.
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    VIF UUID on NSX Manager. If the attachement type is PARENT, this property is required.
    
    Parameters:
    
    id - New value for the property.
  - getTrafficTag
```
public java.lang.Long getTrafficTag()
```
    Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case. format: int64
    
    Returns:
    
    The current value of the property.
  - setTrafficTag
```
public void setTrafficTag(java.lang.Long trafficTag)
```
    Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case. format: int64
    
    Parameters:
    
    trafficTag - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    Type of port attachment. STATIC is added to replace INDEPENDENT. INDEPENDENT type and PARENT type are deprecated.
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    Possible values are:
    Type of port attachment. STATIC is added to replace INDEPENDENT. INDEPENDENT type and PARENT type are deprecated.
    Parameters:
    
    type - New value for 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 PortAttachment _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 PortAttachment _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PortAttachment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALLOCATE_ADDRESSES_IP_POOL

ALLOCATE_ADDRESSES_MAC_POOL

ALLOCATE_ADDRESSES_BOTH

ALLOCATE_ADDRESSES_NONE

ALLOCATE_ADDRESSES_DHCP

ALLOCATE_ADDRESSES_DHCPV6

ALLOCATE_ADDRESSES_SLAAC

CONTEXT_TYPE_PARENT

HYPERBUS_MODE_ENABLE

HYPERBUS_MODE_DISABLE

TYPE_PARENT

TYPE_CHILD

TYPE_INDEPENDENT

TYPE_STATIC

__dynamicStructureFields

Constructor Detail

PortAttachment

PortAttachment

Method Detail

getAllocateAddresses

setAllocateAddresses

getAppId

setAppId

getBmsInterfaceConfig

setBmsInterfaceConfig

getContextId

setContextId

getContextType

setContextType

getEvpnVlans

setEvpnVlans

getHyperbusMode

setHyperbusMode

getId

setId

getTrafficTag

setTrafficTag

getType

setType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2