PacketCaptureOption (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PacketCaptureOption
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The option is used to filter data on given node.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PacketCaptureOption.Builder
Builder class for PacketCaptureOption.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`NAME_DSTIP`
`static java.lang.String`	`NAME_DSTIP6`
`static java.lang.String`	`NAME_DSTMAC`
`static java.lang.String`	`NAME_DSTPORT`
`static java.lang.String`	`NAME_ETHTYPE`
`static java.lang.String`	`NAME_IP`
`static java.lang.String`	`NAME_IP6`
`static java.lang.String`	`NAME_IPPROTO`
`static java.lang.String`	`NAME_IPPROTO6`
`static java.lang.String`	`NAME_MAC`
`static java.lang.String`	`NAME_PORT`
`static java.lang.String`	`NAME_SRCIP`
`static java.lang.String`	`NAME_SRCIP6`
`static java.lang.String`	`NAME_SRCMAC`
`static java.lang.String`	`NAME_SRCPORT`
`static java.lang.String`	`NAME_VLAN`
`static java.lang.String`	`NAME_VNI`

Constructor Summary

Constructors
Modifier Constructor and Description

PacketCaptureOption()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`PacketCaptureOption()` Default constructor.
`protected`	`PacketCaptureOption(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 PacketCaptureOption`	`_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 PacketCaptureOption`	`_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`	`getName()` Possible values are: `NAME_ETHTYPE` `NAME_MAC` `NAME_SRCMAC` `NAME_DSTMAC` `NAME_VLAN` `NAME_IP` `NAME_SRCIP` `NAME_DSTIP` `NAME_IPPROTO` `NAME_PORT` `NAME_SRCPORT` `NAME_DSTPORT` `NAME_VNI` `NAME_IPPROTO6` `NAME_IP6` `NAME_SRCIP6` `NAME_DSTIP6` The avaiable option names in the enum can be used to filter the capture data.
`java.lang.String`	`getValue()` Define the capture value according to the given capture option.
`int`	`hashCode()`
`void`	`setName(java.lang.String name)` Possible values are: `NAME_ETHTYPE` `NAME_MAC` `NAME_SRCMAC` `NAME_DSTMAC` `NAME_VLAN` `NAME_IP` `NAME_SRCIP` `NAME_DSTIP` `NAME_IPPROTO` `NAME_PORT` `NAME_SRCPORT` `NAME_DSTPORT` `NAME_VNI` `NAME_IPPROTO6` `NAME_IP6` `NAME_SRCIP6` `NAME_DSTIP6` The avaiable option names in the enum can be used to filter the capture data.
`void`	`setValue(java.lang.String value)` Define the capture value according to the given capture option.
`java.lang.String`	`toString()`

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

- Field Detail
  - NAME_ETHTYPE
```
public static final java.lang.String NAME_ETHTYPE
```
    See Also:
    
    Constant Field Values
  - NAME_MAC
```
public static final java.lang.String NAME_MAC
```
    See Also:
    
    Constant Field Values
  - NAME_SRCMAC
```
public static final java.lang.String NAME_SRCMAC
```
    See Also:
    
    Constant Field Values
  - NAME_DSTMAC
```
public static final java.lang.String NAME_DSTMAC
```
    See Also:
    
    Constant Field Values
  - NAME_VLAN
```
public static final java.lang.String NAME_VLAN
```
    See Also:
    
    Constant Field Values
  - NAME_IP
```
public static final java.lang.String NAME_IP
```
    See Also:
    
    Constant Field Values
  - NAME_SRCIP
```
public static final java.lang.String NAME_SRCIP
```
    See Also:
    
    Constant Field Values
  - NAME_DSTIP
```
public static final java.lang.String NAME_DSTIP
```
    See Also:
    
    Constant Field Values
  - NAME_IPPROTO
```
public static final java.lang.String NAME_IPPROTO
```
    See Also:
    
    Constant Field Values
  - NAME_PORT
```
public static final java.lang.String NAME_PORT
```
    See Also:
    
    Constant Field Values
  - NAME_SRCPORT
```
public static final java.lang.String NAME_SRCPORT
```
    See Also:
    
    Constant Field Values
  - NAME_DSTPORT
```
public static final java.lang.String NAME_DSTPORT
```
    See Also:
    
    Constant Field Values
  - NAME_VNI
```
public static final java.lang.String NAME_VNI
```
    See Also:
    
    Constant Field Values
  - NAME_IPPROTO6
```
public static final java.lang.String NAME_IPPROTO6
```
    See Also:
    
    Constant Field Values
  - NAME_IP6
```
public static final java.lang.String NAME_IP6
```
    See Also:
    
    Constant Field Values
  - NAME_SRCIP6
```
public static final java.lang.String NAME_SRCIP6
```
    See Also:
    
    Constant Field Values
  - NAME_DSTIP6
```
public static final java.lang.String NAME_DSTIP6
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PacketCaptureOption
```
public PacketCaptureOption()
```
    Default constructor.
  - PacketCaptureOption
```
protected PacketCaptureOption(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Possible values are:
    The avaiable option names in the enum can be used to filter the capture data.
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Possible values are:
    The avaiable option names in the enum can be used to filter the capture data.
    Parameters:
    
    name - New value for the property.
  - getValue
```
public java.lang.String getValue()
```
    Define the capture value according to the given capture option.
    
    Returns:
    
    The current value of the property.
  - setValue
```
public void setValue(java.lang.String value)
```
    Define the capture value according to the given capture option.
    
    Parameters:
    
    value - 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 PacketCaptureOption _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 PacketCaptureOption _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PacketCaptureOption

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_ETHTYPE

NAME_MAC

NAME_SRCMAC

NAME_DSTMAC

NAME_VLAN

NAME_IP

NAME_SRCIP

NAME_DSTIP

NAME_IPPROTO

NAME_PORT

NAME_SRCPORT

NAME_DSTPORT

NAME_VNI

NAME_IPPROTO6

NAME_IP6

NAME_SRCIP6

NAME_DSTIP6

__dynamicStructureFields

Constructor Detail

PacketCaptureOption

PacketCaptureOption

Method Detail

getName

setName

getValue

setValue

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2