com.vmware.nsx.model

Class PacketData

java.lang.Object

com.vmware.nsx.model.PacketData

All Implemented Interfaces:

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

public final class PacketData
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	PacketData.Builder Builder class for PacketData.

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	RESOURCE_TYPE_BINARYPACKETDATA
static java.lang.String	RESOURCE_TYPE_FIELDSPACKETDATA
static java.lang.String	TRANSPORT_TYPE_BROADCAST
static java.lang.String	TRANSPORT_TYPE_MULTICAST
static java.lang.String	TRANSPORT_TYPE_UNICAST
static java.lang.String	TRANSPORT_TYPE_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
	PacketData() Default constructor.
protected	PacketData(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 PacketData	_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 PacketData	_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.Long	getFrameSize() If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.
java.lang.String	getResourceType() Possible values are: RESOURCE_TYPE_BINARYPACKETDATA RESOURCE_TYPE_FIELDSPACKETDATA Packet configuration The value of this property is automatically populated to "PacketData".
java.lang.Boolean	getRouted() When this flag is set, traceflow packet will have its destination overwritten as the gateway address of the logical router to which the source logical switch is connected.
java.lang.String	getTransportType() Possible values are: TRANSPORT_TYPE_BROADCAST TRANSPORT_TYPE_UNICAST TRANSPORT_TYPE_MULTICAST TRANSPORT_TYPE_UNKNOWN This type takes effect only for IP packet.
int	hashCode()
void	setFrameSize(java.lang.Long frameSize) If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.
void	setRouted(java.lang.Boolean routed) When this flag is set, traceflow packet will have its destination overwritten as the gateway address of the logical router to which the source logical switch is connected.
void	setTransportType(java.lang.String transportType) Possible values are: TRANSPORT_TYPE_BROADCAST TRANSPORT_TYPE_UNICAST TRANSPORT_TYPE_MULTICAST TRANSPORT_TYPE_UNKNOWN This type takes effect only for IP packet.
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

RESOURCE_TYPE_BINARYPACKETDATA

public static final java.lang.String RESOURCE_TYPE_BINARYPACKETDATA

See Also:

Constant Field Values

RESOURCE_TYPE_FIELDSPACKETDATA

public static final java.lang.String RESOURCE_TYPE_FIELDSPACKETDATA

See Also:

Constant Field Values

TRANSPORT_TYPE_BROADCAST

public static final java.lang.String TRANSPORT_TYPE_BROADCAST

See Also:

Constant Field Values

TRANSPORT_TYPE_UNICAST

public static final java.lang.String TRANSPORT_TYPE_UNICAST

See Also:

Constant Field Values

TRANSPORT_TYPE_MULTICAST

public static final java.lang.String TRANSPORT_TYPE_MULTICAST

See Also:

Constant Field Values

TRANSPORT_TYPE_UNKNOWN

public static final java.lang.String TRANSPORT_TYPE_UNKNOWN

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

PacketData

public PacketData()

Default constructor.

PacketData

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

Method Detail

getFrameSize

public java.lang.Long getFrameSize()

If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size. format: int64

Returns:

The current value of the property.

setFrameSize

public void setFrameSize(java.lang.Long frameSize)

If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size. format: int64

Parameters:

frameSize - New value for the property.

getResourceType

public java.lang.String getResourceType()

Possible values are:

• RESOURCE_TYPE_BINARYPACKETDATA
• RESOURCE_TYPE_FIELDSPACKETDATA

Packet configuration The value of this property is automatically populated to "PacketData".

Returns:

The current value of the property.

getRouted

public java.lang.Boolean getRouted()

When this flag is set, traceflow packet will have its destination overwritten as the gateway address of the logical router to which the source logical switch is connected. More specifically: - For ARP request, the target IP will be overwritten as gateway IP if the target IP is not in the same subnet of gateway. - For ARP response, the target IP and destination MAC will be overwritten as gateway IP/MAC respectively, if the target IP is not in the same subnet of gateway. - For IP packet, the destination MAC will be overwritten as gateway MAC. However, this flag will not be effective when injecting the traceflow packet to a VLAN backed port. This is because the gateway in this case is a physical gateway that is outside the scope of NSX. Therefore, users need to manually populate the gateway MAC address. If the user still sets this flag in this case, a validation error will be thrown.

Returns:

The current value of the property.

setRouted

public void setRouted(java.lang.Boolean routed)

When this flag is set, traceflow packet will have its destination overwritten as the gateway address of the logical router to which the source logical switch is connected. More specifically: - For ARP request, the target IP will be overwritten as gateway IP if the target IP is not in the same subnet of gateway. - For ARP response, the target IP and destination MAC will be overwritten as gateway IP/MAC respectively, if the target IP is not in the same subnet of gateway. - For IP packet, the destination MAC will be overwritten as gateway MAC. However, this flag will not be effective when injecting the traceflow packet to a VLAN backed port. This is because the gateway in this case is a physical gateway that is outside the scope of NSX. Therefore, users need to manually populate the gateway MAC address. If the user still sets this flag in this case, a validation error will be thrown.

Parameters:

routed - New value for the property.

getTransportType

public java.lang.String getTransportType()

Possible values are:

• TRANSPORT_TYPE_BROADCAST
• TRANSPORT_TYPE_UNICAST
• TRANSPORT_TYPE_MULTICAST
• TRANSPORT_TYPE_UNKNOWN

This type takes effect only for IP packet.

Returns:

The current value of the property.

setTransportType

public void setTransportType(java.lang.String transportType)

Possible values are:

• TRANSPORT_TYPE_BROADCAST
• TRANSPORT_TYPE_UNICAST
• TRANSPORT_TYPE_MULTICAST
• TRANSPORT_TYPE_UNKNOWN

This type takes effect only for IP packet.

Parameters:

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

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