com.vmware.nsx.model

Class LogicalPortAttachmentState

java.lang.Object

com.vmware.nsx.model.LogicalPortAttachmentState

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class LogicalPortAttachmentState
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

VIF attachment state of a logical port

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalPortAttachmentState.Builder Builder class for LogicalPortAttachmentState.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	STATE_ATTACHED
static java.lang.String	STATE_ATTACHED_IN_MOTION
static java.lang.String	STATE_ATTACHED_PENDING_CONF
static java.lang.String	STATE_DETACHED
static java.lang.String	STATE_FREE

Constructor Summary

Constructors

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

Method Summary

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 LogicalPortAttachmentState	_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 LogicalPortAttachmentState	_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.util.List<PortAttacher>	getAttachers() VM or vmknic entities that are attached to the LogicalPort This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
java.lang.String	getId() VIF ID This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
java.lang.String	getState() Possible values are: STATE_FREE STATE_ATTACHED STATE_ATTACHED_PENDING_CONF STATE_ATTACHED_IN_MOTION STATE_DETACHED A logicalPort must be in one of following state.
int	hashCode()
void	setAttachers(java.util.List<PortAttacher> attachers) VM or vmknic entities that are attached to the LogicalPort This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
void	setId(java.lang.String id) VIF ID This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
void	setState(java.lang.String state) Possible values are: STATE_FREE STATE_ATTACHED STATE_ATTACHED_PENDING_CONF STATE_ATTACHED_IN_MOTION STATE_DETACHED A logicalPort must be in one of following state.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STATE_FREE

public static final java.lang.String STATE_FREE

See Also:

Constant Field Values

STATE_ATTACHED

public static final java.lang.String STATE_ATTACHED

See Also:

Constant Field Values

STATE_ATTACHED_PENDING_CONF

public static final java.lang.String STATE_ATTACHED_PENDING_CONF

See Also:

Constant Field Values

STATE_ATTACHED_IN_MOTION

public static final java.lang.String STATE_ATTACHED_IN_MOTION

See Also:

Constant Field Values

STATE_DETACHED

public static final java.lang.String STATE_DETACHED

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

LogicalPortAttachmentState

public LogicalPortAttachmentState()

Default constructor.

LogicalPortAttachmentState

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

Method Detail

getAttachers

public java.util.List<PortAttacher> getAttachers()

VM or vmknic entities that are attached to the LogicalPort 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.

setAttachers

public void setAttachers(java.util.List<PortAttacher> attachers)

VM or vmknic entities that are attached to the LogicalPort 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:

attachers - New value for the property.

getId

public java.lang.String getId()

VIF ID 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.

setId

public void setId(java.lang.String id)

VIF ID 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:

id - New value for the property.

getState

public java.lang.String getState()

Possible values are:

• STATE_FREE
• STATE_ATTACHED
• STATE_ATTACHED_PENDING_CONF
• STATE_ATTACHED_IN_MOTION
• STATE_DETACHED

A logicalPort must be in one of following state. FREE - If there are no active attachers. The LogicalPort may or may not have an attachment ID configured on it. This state is applicable only to LogialPort of static type. ATTACHED - LogicalPort has exactly one active attacher and no further configuration is pending. ATTACHED_PENDING_CONF - LogicalPort has exactly one attacher, however it may not have been configured completely. Additional configuration will be provided by other nsx components. ATTACHED_IN_MOTION - LogicalPort has multiple active attachers. This state represents a scenario where VM is moving from one location (host or storage) to another (e.g. vmotion, vSphere HA) DETACHED - A temporary state after all LogialPort attachers have been detached. This state is applicable only to LogicalPort of ephemeral type and the LogicalPort will soon be deleted. 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.

setState

public void setState(java.lang.String state)

Possible values are:

• STATE_FREE
• STATE_ATTACHED
• STATE_ATTACHED_PENDING_CONF
• STATE_ATTACHED_IN_MOTION
• STATE_DETACHED

A logicalPort must be in one of following state. FREE - If there are no active attachers. The LogicalPort may or may not have an attachment ID configured on it. This state is applicable only to LogialPort of static type. ATTACHED - LogicalPort has exactly one active attacher and no further configuration is pending. ATTACHED_PENDING_CONF - LogicalPort has exactly one attacher, however it may not have been configured completely. Additional configuration will be provided by other nsx components. ATTACHED_IN_MOTION - LogicalPort has multiple active attachers. This state represents a scenario where VM is moving from one location (host or storage) to another (e.g. vmotion, vSphere HA) DETACHED - A temporary state after all LogialPort attachers have been detached. This state is applicable only to LogicalPort of ephemeral type and the LogicalPort will soon be deleted. 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:

state - 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 LogicalPortAttachmentState _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 LogicalPortAttachmentState _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.