PacketCaptureRequest.Builder (Java SDK for NSX Manager API 4.1.2.0.0)

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

Enclosing class:: PacketCaptureRequest

public static final class PacketCaptureRequest.Builder
extends java.lang.Object

Builder class for PacketCaptureRequest.

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor with parameters for the required properties of PacketCaptureRequest.

Constructors
Constructor and Description
`Builder()` Constructor with parameters for the required properties of `PacketCaptureRequest`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PacketCaptureRequest`	`build()`
`PacketCaptureRequest.Builder`	`setCapamount(java.lang.Long capamount)` Define the packet capture amount size.
`PacketCaptureRequest.Builder`	`setCapcore(java.lang.Long capcore)` The CPU core id on Edge node.
`PacketCaptureRequest.Builder`	`setCapduration(java.lang.Long capduration)` Define the packet capture duration time.
`PacketCaptureRequest.Builder`	`setCapfilesize(java.lang.Long capfilesize)` Define the packet capture file size limit.
`PacketCaptureRequest.Builder`	`setCapmode(java.lang.String capmode)` Possible values are: `PacketCaptureRequest.CAPMODE_STANDALONE` `PacketCaptureRequest.CAPMODE_STREAM` Define the capture streaming mode.
`PacketCaptureRequest.Builder`	`setCappoint(java.lang.String cappoint)` Possible values are: `PacketCaptureRequest.CAPPOINT_VNIC` `PacketCaptureRequest.CAPPOINT_VMKNIC` `PacketCaptureRequest.CAPPOINT_VMNIC` `PacketCaptureRequest.CAPPOINT_VDRPORT` `PacketCaptureRequest.CAPPOINT_DVFILTER` `PacketCaptureRequest.CAPPOINT_LOGICALPORT` `PacketCaptureRequest.CAPPOINT_FCPORT` `PacketCaptureRequest.CAPPOINT_VIF` `PacketCaptureRequest.CAPPOINT_PNIC` Define the point to capture data.
`PacketCaptureRequest.Builder`	`setCaprate(java.lang.Long caprate)` Define the rate of packet capture process.
`PacketCaptureRequest.Builder`	`setCapsnaplen(java.lang.Long capsnaplen)` Limit the number of bytes captured from each packet.
`PacketCaptureRequest.Builder`	`setCapsource(java.lang.String capsource)` Possible values are: `PacketCaptureRequest.CAPSOURCE_CLI` `PacketCaptureRequest.CAPSOURCE_UI` This type is used to differenite the incoming request from CLI/UI.
`PacketCaptureRequest.Builder`	`setCapvalue(java.lang.String capvalue)` Define the capture value of given capture point.
`PacketCaptureRequest.Builder`	`setDirection(java.lang.String direction)` Possible values are: `PacketCaptureRequest.DIRECTION_INPUT` `PacketCaptureRequest.DIRECTION_OUTPUT` `PacketCaptureRequest.DIRECTION_DUAL` Define the capture direction.
`PacketCaptureRequest.Builder`	`setFiltertype(java.lang.String filtertype)` Possible values are: `PacketCaptureRequest.FILTERTYPE_PRE` `PacketCaptureRequest.FILTERTYPE_POST` Define the capture filter type.
`PacketCaptureRequest.Builder`	`setNode(java.lang.String node)` Define the transport node to capture data.
`PacketCaptureRequest.Builder`	`setNodeIp(java.lang.String nodeIp)` Define the transport node to capture data.
`PacketCaptureRequest.Builder`	`setOptions(PacketCaptureOptionList options)`
`PacketCaptureRequest.Builder`	`setStreamaddress(java.lang.String streamaddress)` Set the stream address to receive the capture packet.
`PacketCaptureRequest.Builder`	`setStreamport(java.lang.Long streamport)` Set the stream port to receive the capture packet.

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

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructor with parameters for the required properties of PacketCaptureRequest.
- Method Detail
  - setCapamount
```
public PacketCaptureRequest.Builder setCapamount(java.lang.Long capamount)
```
    Define the packet capture amount size. format: int32
    
    Parameters:
    
    capamount - New value for the property.
  - setCapcore
```
public PacketCaptureRequest.Builder setCapcore(java.lang.Long capcore)
```
    The CPU core id on Edge node. format: int32
    
    Parameters:
    
    capcore - New value for the property.
  - setCapduration
```
public PacketCaptureRequest.Builder 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.
  - setCapfilesize
```
public PacketCaptureRequest.Builder setCapfilesize(java.lang.Long capfilesize)
```
    Define the packet capture file size limit. format: int32
    
    Parameters:
    
    capfilesize - New value for the property.
  - setCapmode
```
public PacketCaptureRequest.Builder setCapmode(java.lang.String capmode)
```
    Possible values are:
    - PacketCaptureRequest.CAPMODE_STANDALONE
    - PacketCaptureRequest.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.
  - setCappoint
```
public PacketCaptureRequest.Builder setCappoint(java.lang.String cappoint)
```
    Possible values are:
    Define the point to capture data.
    Parameters:
    
    cappoint - New value for the property.
  - setCaprate
```
public PacketCaptureRequest.Builder setCaprate(java.lang.Long caprate)
```
    Define the rate of packet capture process. format: int32
    
    Parameters:
    
    caprate - New value for the property.
  - setCapsnaplen
```
public PacketCaptureRequest.Builder setCapsnaplen(java.lang.Long capsnaplen)
```
    Limit the number of bytes captured from each packet. format: int32
    
    Parameters:
    
    capsnaplen - New value for the property.
  - setCapsource
```
public PacketCaptureRequest.Builder setCapsource(java.lang.String capsource)
```
    Possible values are:
    - PacketCaptureRequest.CAPSOURCE_CLI
    - PacketCaptureRequest.CAPSOURCE_UI
    This type is used to differenite the incoming request from CLI/UI.
    Parameters:
    
    capsource - New value for the property.
  - setCapvalue
```
public PacketCaptureRequest.Builder setCapvalue(java.lang.String capvalue)
```
    Define the capture value of given capture point.
    
    Parameters:
    
    capvalue - New value for the property.
  - setDirection
```
public PacketCaptureRequest.Builder 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.
  - setFiltertype
```
public PacketCaptureRequest.Builder setFiltertype(java.lang.String filtertype)
```
    Possible values are:
    - PacketCaptureRequest.FILTERTYPE_PRE
    - PacketCaptureRequest.FILTERTYPE_POST
    Define the capture filter type. Support PRE/POST mode.
    Parameters:
    
    filtertype - New value for the property.
  - setNode
```
public PacketCaptureRequest.Builder setNode(java.lang.String node)
```
    Define the transport node to capture data.
    
    Parameters:
    
    node - New value for the property.
  - setNodeIp
```
public PacketCaptureRequest.Builder setNodeIp(java.lang.String nodeIp)
```
    Define the transport node to capture data. format: ip
    
    Parameters:
    
    nodeIp - New value for the property.
  - setOptions
```
public PacketCaptureRequest.Builder setOptions(PacketCaptureOptionList options)
```
    Parameters:
    
    options - New value for the property.
  - setStreamaddress
```
public PacketCaptureRequest.Builder setStreamaddress(java.lang.String streamaddress)
```
    Set the stream address to receive the capture packet.
    
    Parameters:
    
    streamaddress - New value for the property.
  - setStreamport
```
public PacketCaptureRequest.Builder 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.
  - build
```
public PacketCaptureRequest build()
```

Class PacketCaptureRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setCapamount

setCapcore

setCapduration

setCapfilesize

setCapmode

setCappoint

setCaprate

setCapsnaplen

setCapsource

setCapvalue

setDirection

setFiltertype

setNode

setNodeIp

setOptions

setStreamaddress

setStreamport

build