PacketCaptureRequest (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PacketCaptureRequest
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This type is used to create packet request on give node. Need to specify related parameters according to the capture point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PacketCaptureRequest.Builder
Builder class for PacketCaptureRequest.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`CAPMODE_STANDALONE`
`static java.lang.String`	`CAPMODE_STREAM`
`static java.lang.String`	`CAPPOINT_DVFILTER`
`static java.lang.String`	`CAPPOINT_FCPORT`
`static java.lang.String`	`CAPPOINT_LOGICALPORT`
`static java.lang.String`	`CAPPOINT_PNIC`
`static java.lang.String`	`CAPPOINT_VDRPORT`
`static java.lang.String`	`CAPPOINT_VIF`
`static java.lang.String`	`CAPPOINT_VMKNIC`
`static java.lang.String`	`CAPPOINT_VMNIC`
`static java.lang.String`	`CAPPOINT_VNIC`
`static java.lang.String`	`CAPSOURCE_CLI`
`static java.lang.String`	`CAPSOURCE_UI`
`static java.lang.String`	`DIRECTION_DUAL`
`static java.lang.String`	`DIRECTION_INPUT`
`static java.lang.String`	`DIRECTION_OUTPUT`
`static java.lang.String`	`FILTERTYPE_POST`
`static java.lang.String`	`FILTERTYPE_PRE`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PacketCaptureRequest()` Default constructor.
`protected`	`PacketCaptureRequest(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 PacketCaptureRequest`	`_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 PacketCaptureRequest`	`_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`	`getCapamount()` Define the packet capture amount size.
`java.lang.Long`	`getCapcore()` The CPU core id on Edge node.
`java.lang.Long`	`getCapduration()` Define the packet capture duration time.
`java.lang.Long`	`getCapfilesize()` Define the packet capture file size limit.
`java.lang.String`	`getCapmode()` Possible values are: `CAPMODE_STANDALONE` `CAPMODE_STREAM` Define the capture streaming mode.
`java.lang.String`	`getCappoint()` Possible values are: `CAPPOINT_VNIC` `CAPPOINT_VMKNIC` `CAPPOINT_VMNIC` `CAPPOINT_VDRPORT` `CAPPOINT_DVFILTER` `CAPPOINT_LOGICALPORT` `CAPPOINT_FCPORT` `CAPPOINT_VIF` `CAPPOINT_PNIC` Define the point to capture data.
`java.lang.Long`	`getCaprate()` Define the rate of packet capture process.
`java.lang.Long`	`getCapsnaplen()` Limit the number of bytes captured from each packet.
`java.lang.String`	`getCapsource()` Possible values are: `CAPSOURCE_CLI` `CAPSOURCE_UI` This type is used to differenite the incoming request from CLI/UI.
`java.lang.String`	`getCapvalue()` Define the capture value of given capture point.
`java.lang.String`	`getDirection()` Possible values are: `DIRECTION_INPUT` `DIRECTION_OUTPUT` `DIRECTION_DUAL` Define the capture direction.
`java.lang.String`	`getFiltertype()` Possible values are: `FILTERTYPE_PRE` `FILTERTYPE_POST` Define the capture filter type.
`java.lang.String`	`getNode()` Define the transport node to capture data.
`java.lang.String`	`getNodeIp()` Define the transport node to capture data.
`PacketCaptureOptionList`	`getOptions()`
`java.lang.String`	`getStreamaddress()` Set the stream address to receive the capture packet.
`java.lang.Long`	`getStreamport()` Set the stream port to receive the capture packet.
`int`	`hashCode()`
`void`	`setCapamount(java.lang.Long capamount)` Define the packet capture amount size.
`void`	`setCapcore(java.lang.Long capcore)` The CPU core id on Edge node.
`void`	`setCapduration(java.lang.Long capduration)` Define the packet capture duration time.
`void`	`setCapfilesize(java.lang.Long capfilesize)` Define the packet capture file size limit.
`void`	`setCapmode(java.lang.String capmode)` Possible values are: `CAPMODE_STANDALONE` `CAPMODE_STREAM` Define the capture streaming mode.
`void`	`setCappoint(java.lang.String cappoint)` Possible values are: `CAPPOINT_VNIC` `CAPPOINT_VMKNIC` `CAPPOINT_VMNIC` `CAPPOINT_VDRPORT` `CAPPOINT_DVFILTER` `CAPPOINT_LOGICALPORT` `CAPPOINT_FCPORT` `CAPPOINT_VIF` `CAPPOINT_PNIC` Define the point to capture data.
`void`	`setCaprate(java.lang.Long caprate)` Define the rate of packet capture process.
`void`	`setCapsnaplen(java.lang.Long capsnaplen)` Limit the number of bytes captured from each packet.
`void`	`setCapsource(java.lang.String capsource)` Possible values are: `CAPSOURCE_CLI` `CAPSOURCE_UI` This type is used to differenite the incoming request from CLI/UI.
`void`	`setCapvalue(java.lang.String capvalue)` Define the capture value of given capture point.
`void`	`setDirection(java.lang.String direction)` Possible values are: `DIRECTION_INPUT` `DIRECTION_OUTPUT` `DIRECTION_DUAL` Define the capture direction.
`void`	`setFiltertype(java.lang.String filtertype)` Possible values are: `FILTERTYPE_PRE` `FILTERTYPE_POST` Define the capture filter type.
`void`	`setNode(java.lang.String node)` Define the transport node to capture data.
`void`	`setNodeIp(java.lang.String nodeIp)` Define the transport node to capture data.
`void`	`setOptions(PacketCaptureOptionList options)`
`void`	`setStreamaddress(java.lang.String streamaddress)` Set the stream address to receive the capture packet.
`void`	`setStreamport(java.lang.Long streamport)` Set the stream port to receive the capture packet.
`java.lang.String`	`toString()`

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

- Field Detail
  - CAPMODE_STANDALONE
```
public static final java.lang.String CAPMODE_STANDALONE
```
    See Also:
    
    Constant Field Values
  - CAPMODE_STREAM
```
public static final java.lang.String CAPMODE_STREAM
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_VNIC
```
public static final java.lang.String CAPPOINT_VNIC
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_VMKNIC
```
public static final java.lang.String CAPPOINT_VMKNIC
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_VMNIC
```
public static final java.lang.String CAPPOINT_VMNIC
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_VDRPORT
```
public static final java.lang.String CAPPOINT_VDRPORT
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_DVFILTER
```
public static final java.lang.String CAPPOINT_DVFILTER
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_LOGICALPORT
```
public static final java.lang.String CAPPOINT_LOGICALPORT
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_FCPORT
```
public static final java.lang.String CAPPOINT_FCPORT
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_VIF
```
public static final java.lang.String CAPPOINT_VIF
```
    See Also:
    
    Constant Field Values
  - CAPPOINT_PNIC
```
public static final java.lang.String CAPPOINT_PNIC
```
    See Also:
    
    Constant Field Values
  - CAPSOURCE_CLI
```
public static final java.lang.String CAPSOURCE_CLI
```
    See Also:
    
    Constant Field Values
  - CAPSOURCE_UI
```
public static final java.lang.String CAPSOURCE_UI
```
    See Also:
    
    Constant Field Values
  - DIRECTION_INPUT
```
public static final java.lang.String DIRECTION_INPUT
```
    See Also:
    
    Constant Field Values
  - DIRECTION_OUTPUT
```
public static final java.lang.String DIRECTION_OUTPUT
```
    See Also:
    
    Constant Field Values
  - DIRECTION_DUAL
```
public static final java.lang.String DIRECTION_DUAL
```
    See Also:
    
    Constant Field Values
  - FILTERTYPE_PRE
```
public static final java.lang.String FILTERTYPE_PRE
```
    See Also:
    
    Constant Field Values
  - FILTERTYPE_POST
```
public static final java.lang.String FILTERTYPE_POST
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PacketCaptureRequest
```
public PacketCaptureRequest()
```
    Default constructor.
  - PacketCaptureRequest
```
protected PacketCaptureRequest(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCapamount
```
public java.lang.Long getCapamount()
```
    Define the packet capture amount size. format: int32
    
    Returns:
    
    The current value of the property.
  - setCapamount
```
public void setCapamount(java.lang.Long capamount)
```
    Define the packet capture amount size. format: int32
    
    Parameters:
    
    capamount - New value for the property.
  - getCapcore
```
public java.lang.Long getCapcore()
```
    The CPU core id on Edge node. format: int32
    
    Returns:
    
    The current value of the property.
  - setCapcore
```
public void setCapcore(java.lang.Long capcore)
```
    The CPU core id on Edge node. format: int32
    
    Parameters:
    
    capcore - New value for the property.
  - getCapduration
```
public java.lang.Long getCapduration()
```
    Define the packet capture duration time. After the capture duration time, the capture process will stop working. format: int32
    
    Returns:
    
    The current value of the property.
  - setCapduration
```
public void setCapduration(java.lang.Long capduration)
```
    Define the packet capture duration time. After the capture duration time, the capture process will stop working. format: int32
    
    Parameters:
    
    capduration - New value for the property.
  - getCapfilesize
```
public java.lang.Long getCapfilesize()
```
    Define the packet capture file size limit. format: int32
    
    Returns:
    
    The current value of the property.
  - setCapfilesize
```
public void setCapfilesize(java.lang.Long capfilesize)
```
    Define the packet capture file size limit. format: int32
    
    Parameters:
    
    capfilesize - New value for the property.
  - getCapmode
```
public java.lang.String getCapmode()
```
    Possible values are:
    - CAPMODE_STANDALONE
    - CAPMODE_STREAM
    Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.
    Returns:
    
    The current value of the property.
  - setCapmode
```
public void setCapmode(java.lang.String capmode)
```
    Possible values are:
    - CAPMODE_STANDALONE
    - CAPMODE_STREAM
    Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.
    Parameters:
    
    capmode - New value for the property.
  - getCappoint
```
public java.lang.String getCappoint()
```
    Possible values are:
    Define the point to capture data.
    Returns:
    
    The current value of the property.
  - setCappoint
```
public void setCappoint(java.lang.String cappoint)
```
    Possible values are:
    Define the point to capture data.
    Parameters:
    
    cappoint - New value for the property.
  - getCaprate
```
public java.lang.Long getCaprate()
```
    Define the rate of packet capture process. format: int32
    
    Returns:
    
    The current value of the property.
  - setCaprate
```
public void setCaprate(java.lang.Long caprate)
```
    Define the rate of packet capture process. format: int32
    
    Parameters:
    
    caprate - New value for the property.
  - getCapsnaplen
```
public java.lang.Long getCapsnaplen()
```
    Limit the number of bytes captured from each packet. format: int32
    
    Returns:
    
    The current value of the property.
  - setCapsnaplen
```
public void setCapsnaplen(java.lang.Long capsnaplen)
```
    Limit the number of bytes captured from each packet. format: int32
    
    Parameters:
    
    capsnaplen - New value for the property.
  - getCapsource
```
public java.lang.String getCapsource()
```
    Possible values are:
    - CAPSOURCE_CLI
    - CAPSOURCE_UI
    This type is used to differenite the incoming request from CLI/UI.
    Returns:
    
    The current value of the property.
  - setCapsource
```
public void setCapsource(java.lang.String capsource)
```
    Possible values are:
    - CAPSOURCE_CLI
    - CAPSOURCE_UI
    This type is used to differenite the incoming request from CLI/UI.
    Parameters:
    
    capsource - New value for the property.
  - getCapvalue
```
public java.lang.String getCapvalue()
```
    Define the capture value of given capture point.
    
    Returns:
    
    The current value of the property.
  - setCapvalue
```
public void setCapvalue(java.lang.String capvalue)
```
    Define the capture value of given capture point.
    
    Parameters:
    
    capvalue - New value for the property.
  - getDirection
```
public java.lang.String getDirection()
```
    Possible values are:
    Define the capture direction. Support three types INPUT/OUTPUT/DUAL.
    Returns:
    
    The current value of the property.
  - setDirection
```
public void setDirection(java.lang.String direction)
```
    Possible values are:
    Define the capture direction. Support three types INPUT/OUTPUT/DUAL.
    Parameters:
    
    direction - New value for the property.
  - getFiltertype
```
public java.lang.String getFiltertype()
```
    Possible values are:
    - FILTERTYPE_PRE
    - FILTERTYPE_POST
    Define the capture filter type. Support PRE/POST mode.
    Returns:
    
    The current value of the property.
  - setFiltertype
```
public void setFiltertype(java.lang.String filtertype)
```
    Possible values are:
    - FILTERTYPE_PRE
    - FILTERTYPE_POST
    Define the capture filter type. Support PRE/POST mode.
    Parameters:
    
    filtertype - New value for the property.
  - getNode
```
public java.lang.String getNode()
```
    Define the transport node to capture data.
    
    Returns:
    
    The current value of the property.
  - setNode
```
public void setNode(java.lang.String node)
```
    Define the transport node to capture data.
    
    Parameters:
    
    node - New value for the property.
  - getNodeIp
```
public java.lang.String getNodeIp()
```
    Define the transport node to capture data. format: ip
    
    Returns:
    
    The current value of the property.
  - setNodeIp
```
public void setNodeIp(java.lang.String nodeIp)
```
    Define the transport node to capture data. format: ip
    
    Parameters:
    
    nodeIp - New value for the property.
  - getOptions
```
public PacketCaptureOptionList getOptions()
```
    Returns:
    
    The current value of the property.
  - setOptions
```
public void setOptions(PacketCaptureOptionList options)
```
    Parameters:
    
    options - New value for the property.
  - getStreamaddress
```
public java.lang.String getStreamaddress()
```
    Set the stream address to receive the capture packet.
    
    Returns:
    
    The current value of the property.
  - setStreamaddress
```
public void setStreamaddress(java.lang.String streamaddress)
```
    Set the stream address to receive the capture packet.
    
    Parameters:
    
    streamaddress - New value for the property.
  - getStreamport
```
public java.lang.Long getStreamport()
```
    Set the stream port to receive the capture packet. The STREAM mode is based on GRE-in-UDP Encapsulation(RFC8086). Packets are sent to UDP port 4754. format: int32
    
    Returns:
    
    The current value of the property.
  - setStreamport
```
public void setStreamport(java.lang.Long streamport)
```
    Set the stream port to receive the capture packet. The STREAM mode is based on GRE-in-UDP Encapsulation(RFC8086). Packets are sent to UDP port 4754. format: int32
    
    Parameters:
    
    streamport - 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 PacketCaptureRequest _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 PacketCaptureRequest _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PacketCaptureRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAPMODE_STANDALONE

CAPMODE_STREAM

CAPPOINT_VNIC

CAPPOINT_VMKNIC

CAPPOINT_VMNIC

CAPPOINT_VDRPORT

CAPPOINT_DVFILTER

CAPPOINT_LOGICALPORT

CAPPOINT_FCPORT

CAPPOINT_VIF

CAPPOINT_PNIC

CAPSOURCE_CLI

CAPSOURCE_UI

DIRECTION_INPUT

DIRECTION_OUTPUT

DIRECTION_DUAL

FILTERTYPE_PRE

FILTERTYPE_POST

__dynamicStructureFields

Constructor Detail

PacketCaptureRequest

PacketCaptureRequest

Method Detail

getCapamount

setCapamount

getCapcore

setCapcore

getCapduration

setCapduration

getCapfilesize

setCapfilesize

getCapmode

setCapmode

getCappoint

setCappoint

getCaprate

setCaprate

getCapsnaplen

setCapsnaplen

getCapsource

setCapsource

getCapvalue

setCapvalue

getDirection

setDirection

getFiltertype

setFiltertype

getNode

setNode

getNodeIp

setNodeIp

getOptions

setOptions

getStreamaddress

setStreamaddress

getStreamport

setStreamport

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance