com.vmware.nsx_policy.model

Class FieldsPacketData.Builder

java.lang.Object

com.vmware.nsx_policy.model.FieldsPacketData.Builder

Enclosing class:

FieldsPacketData

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

Builder class for FieldsPacketData.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FieldsPacketData	build()
FieldsPacketData.Builder	setArpHeader(ArpHeader arpHeader)
FieldsPacketData.Builder	setEthHeader(EthernetHeader ethHeader)
FieldsPacketData.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.
FieldsPacketData.Builder	setIpHeader(Ipv4Header ipHeader)
FieldsPacketData.Builder	setIpv6Header(Ipv6Header ipv6Header)
FieldsPacketData.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.
FieldsPacketData.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.
FieldsPacketData.Builder	setTransportHeader(TransportProtocolHeader transportHeader)
FieldsPacketData.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 FieldsPacketData.

Method Detail

setArpHeader

public FieldsPacketData.Builder setArpHeader(ArpHeader arpHeader)

Parameters:

arpHeader - New value for the property.

setEthHeader

public FieldsPacketData.Builder setEthHeader(EthernetHeader ethHeader)

Parameters:

ethHeader - New value for the property.

setIpHeader

public FieldsPacketData.Builder setIpHeader(Ipv4Header ipHeader)

Parameters:

ipHeader - New value for the property.

setIpv6Header

public FieldsPacketData.Builder setIpv6Header(Ipv6Header ipv6Header)

Parameters:

ipv6Header - New value for the property.

setPayload

public FieldsPacketData.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 contains any data the user wants to put after the transport header.

Parameters:

payload - New value for the property.

setTransportHeader

public FieldsPacketData.Builder setTransportHeader(TransportProtocolHeader transportHeader)

Parameters:

transportHeader - New value for the property.

setFrameSize

public FieldsPacketData.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 FieldsPacketData.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 FieldsPacketData.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 FieldsPacketData build()