com.vmware.nsx.model

Class BinaryPacketData.Builder

java.lang.Object

com.vmware.nsx.model.BinaryPacketData.Builder

Enclosing class:

BinaryPacketData

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

Builder class for BinaryPacketData.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of BinaryPacketData.

Method Summary

Modifier and Type	Method and Description
BinaryPacketData	build()
BinaryPacketData.Builder	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.
BinaryPacketData.Builder	setPayload(java.lang.String payload) Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload.
BinaryPacketData.Builder	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.
BinaryPacketData.Builder	setTransportType(java.lang.String transportType) Possible values are: PacketData.TRANSPORT_TYPE_BROADCAST PacketData.TRANSPORT_TYPE_UNICAST PacketData.TRANSPORT_TYPE_MULTICAST PacketData.TRANSPORT_TYPE_UNKNOWN This type takes effect only for IP 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 BinaryPacketData.

Method Detail

setPayload

public BinaryPacketData.Builder setPayload(java.lang.String payload)

Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload must contain all headers (Ethernet, IP, etc). Note that VLAN is not supported in the logical space. Hence, payload must not contain 802.1Q headers.

Parameters:

payload - New value for the property.

setFrameSize

public BinaryPacketData.Builder 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.

setRouted

public BinaryPacketData.Builder 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.

setTransportType

public BinaryPacketData.Builder setTransportType(java.lang.String transportType)

Possible values are:

• PacketData.TRANSPORT_TYPE_BROADCAST
• PacketData.TRANSPORT_TYPE_UNICAST
• PacketData.TRANSPORT_TYPE_MULTICAST
• PacketData.TRANSPORT_TYPE_UNKNOWN

This type takes effect only for IP packet.

Parameters:

transportType - New value for the property.

build

public BinaryPacketData build()