com.vmware.nsx_global_policy.model

Class ALBTCPProxyProfile.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBTCPProxyProfile.Builder

Enclosing class:

ALBTCPProxyProfile

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

Builder class for ALBTCPProxyProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBTCPProxyProfile	build()
ALBTCPProxyProfile.Builder	setAggressiveCongestionAvoidance(java.lang.Boolean aggressiveCongestionAvoidance) Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses.
ALBTCPProxyProfile.Builder	setAutomatic(java.lang.Boolean automatic) Dynamically pick the relevant parameters for connections.
ALBTCPProxyProfile.Builder	setAutoWindowGrowth(java.lang.Boolean autoWindowGrowth) Controls whether the windows are static or supports autogrowth.
ALBTCPProxyProfile.Builder	setCcAlgo(java.lang.String ccAlgo) Possible values are: ALBTCPProxyProfile.CC_ALGO_NEW_RENO ALBTCPProxyProfile.CC_ALGO_CUBIC ALBTCPProxyProfile.CC_ALGO_HTCP Controls the congestion control algorithm we use.
ALBTCPProxyProfile.Builder	setCongestionRecoveryScalingFactor(java.lang.Long congestionRecoveryScalingFactor) Congestion window scaling factor after recovery.
ALBTCPProxyProfile.Builder	setIdleConnectionTimeout(java.lang.Long idleConnectionTimeout) The duration for keepalive probes or session idle timeout.
ALBTCPProxyProfile.Builder	setIdleConnectionType(java.lang.String idleConnectionType) Possible values are: ALBTCPProxyProfile.IDLE_CONNECTION_TYPE_KEEP_ALIVE ALBTCPProxyProfile.IDLE_CONNECTION_TYPE_CLOSE_IDLE Controls the behavior of idle connections.
ALBTCPProxyProfile.Builder	setIgnoreTimeWait(java.lang.Boolean ignoreTimeWait) A new SYN is accepted from the same 4-tuple even if there is already a connection in TIME_WAIT state.
ALBTCPProxyProfile.Builder	setIpDscp(java.lang.Long ipDscp) Controls the value of the Differentiated Services Code Point field inserted in the IP header.
ALBTCPProxyProfile.Builder	setKeepaliveInHalfcloseState(java.lang.Boolean keepaliveInHalfcloseState) Controls whether to keep the connection alive with keepalive messages in the TCP half close state.
ALBTCPProxyProfile.Builder	setMaxRetransmissions(java.lang.Long maxRetransmissions) The number of attempts at retransmit before closing the connection.
ALBTCPProxyProfile.Builder	setMaxSegmentSize(java.lang.Long maxSegmentSize) Maximum TCP segment size.
ALBTCPProxyProfile.Builder	setMaxSynRetransmissions(java.lang.Long maxSynRetransmissions) The maximum number of attempts at retransmitting a SYN packet before giving up.
ALBTCPProxyProfile.Builder	setMinRexmtTimeout(java.lang.Long minRexmtTimeout) The minimum wait time (in millisec) to retransmit packet.
ALBTCPProxyProfile.Builder	setNaglesAlgorithm(java.lang.Boolean naglesAlgorithm) Consolidates small data packets to send clients fewer but larger packets.
ALBTCPProxyProfile.Builder	setReassemblyQueueSize(java.lang.Long reassemblyQueueSize) Maximum number of TCP segments that can be queued for reassembly.
ALBTCPProxyProfile.Builder	setReceiveWindow(java.lang.Long receiveWindow) Size of the receive window.
ALBTCPProxyProfile.Builder	setReorderThreshold(java.lang.Long reorderThreshold) Controls the number of duplicate acks required to trigger retransmission.
ALBTCPProxyProfile.Builder	setSlowStartScalingFactor(java.lang.Long slowStartScalingFactor) Congestion window scaling factor during slow start.
ALBTCPProxyProfile.Builder	setTimeWaitDelay(java.lang.Long timeWaitDelay) The time (in millisec) to wait before closing a connection in the TIME_WAIT state.
ALBTCPProxyProfile.Builder	setUseInterfaceMtu(java.lang.Boolean useInterfaceMtu) Use the interface MTU to calculate the TCP max segment size.

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 ALBTCPProxyProfile.

Method Detail

setAggressiveCongestionAvoidance

public ALBTCPProxyProfile.Builder setAggressiveCongestionAvoidance(java.lang.Boolean aggressiveCongestionAvoidance)

Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

aggressiveCongestionAvoidance - New value for the property.

setAutoWindowGrowth

public ALBTCPProxyProfile.Builder setAutoWindowGrowth(java.lang.Boolean autoWindowGrowth)

Controls whether the windows are static or supports autogrowth. Maximum that it can grow to is limited to 4MB. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

autoWindowGrowth - New value for the property.

setAutomatic

public ALBTCPProxyProfile.Builder setAutomatic(java.lang.Boolean automatic)

Dynamically pick the relevant parameters for connections. Allowed in Basic(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

automatic - New value for the property.

setCcAlgo

public ALBTCPProxyProfile.Builder setCcAlgo(java.lang.String ccAlgo)

Possible values are:

• ALBTCPProxyProfile.CC_ALGO_NEW_RENO
• ALBTCPProxyProfile.CC_ALGO_CUBIC
• ALBTCPProxyProfile.CC_ALGO_HTCP

Controls the congestion control algorithm we use. Enum options - CC_ALGO_NEW_RENO, CC_ALGO_CUBIC, CC_ALGO_HTCP. Default value when not specified in API or module is interpreted by ALB Controller as CC_ALGO_NEW_RENO.

Parameters:

ccAlgo - New value for the property.

setCongestionRecoveryScalingFactor

public ALBTCPProxyProfile.Builder setCongestionRecoveryScalingFactor(java.lang.Long congestionRecoveryScalingFactor)

Congestion window scaling factor after recovery. Allowed values are 0-8. Default value when not specified in API or module is interpreted by ALB Controller as 2. format: int64

Parameters:

congestionRecoveryScalingFactor - New value for the property.

setIdleConnectionTimeout

public ALBTCPProxyProfile.Builder setIdleConnectionTimeout(java.lang.Long idleConnectionTimeout)

The duration for keepalive probes or session idle timeout. Max value is 3600 seconds, min is 5. Set to 0 to allow infinite idle time. Allowed values are 5-14400. Special values are 0 - 'infinite'. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 600. format: int64

Parameters:

idleConnectionTimeout - New value for the property.

setIdleConnectionType

public ALBTCPProxyProfile.Builder setIdleConnectionType(java.lang.String idleConnectionType)

Possible values are:

• ALBTCPProxyProfile.IDLE_CONNECTION_TYPE_KEEP_ALIVE
• ALBTCPProxyProfile.IDLE_CONNECTION_TYPE_CLOSE_IDLE

Controls the behavior of idle connections. Enum options - KEEP_ALIVE, CLOSE_IDLE. Default value when not specified in API or module is interpreted by ALB Controller as KEEP_ALIVE.

Parameters:

idleConnectionType - New value for the property.

setIgnoreTimeWait

public ALBTCPProxyProfile.Builder setIgnoreTimeWait(java.lang.Boolean ignoreTimeWait)

A new SYN is accepted from the same 4-tuple even if there is already a connection in TIME_WAIT state. This is equivalent of setting Time Wait Delay to 0. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

ignoreTimeWait - New value for the property.

setIpDscp

public ALBTCPProxyProfile.Builder setIpDscp(java.lang.Long ipDscp)

Controls the value of the Differentiated Services Code Point field inserted in the IP header. This has two options Set to a specific value, or Pass Through, which uses the incoming DSCP value. Allowed values are 0-63. Special values are MAX - 'Passthrough'. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

ipDscp - New value for the property.

setKeepaliveInHalfcloseState

public ALBTCPProxyProfile.Builder setKeepaliveInHalfcloseState(java.lang.Boolean keepaliveInHalfcloseState)

Controls whether to keep the connection alive with keepalive messages in the TCP half close state. The interval for sending keepalive messages is 30s. If a timeout is already configured in the network profile, this will not override it. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

keepaliveInHalfcloseState - New value for the property.

setMaxRetransmissions

public ALBTCPProxyProfile.Builder setMaxRetransmissions(java.lang.Long maxRetransmissions)

The number of attempts at retransmit before closing the connection. Allowed values are 3-8. Default value when not specified in API or module is interpreted by ALB Controller as 8. format: int64

Parameters:

maxRetransmissions - New value for the property.

setMaxSegmentSize

public ALBTCPProxyProfile.Builder setMaxSegmentSize(java.lang.Long maxSegmentSize)

Maximum TCP segment size. Allowed values are 512-9000. Special values are 0 - 'Use Interface MTU'. Unit is BYTES. format: int64

Parameters:

maxSegmentSize - New value for the property.

setMaxSynRetransmissions

public ALBTCPProxyProfile.Builder setMaxSynRetransmissions(java.lang.Long maxSynRetransmissions)

The maximum number of attempts at retransmitting a SYN packet before giving up. Allowed values are 3-8. Default value when not specified in API or module is interpreted by ALB Controller as 8. format: int64

Parameters:

maxSynRetransmissions - New value for the property.

setMinRexmtTimeout

public ALBTCPProxyProfile.Builder setMinRexmtTimeout(java.lang.Long minRexmtTimeout)

The minimum wait time (in millisec) to retransmit packet. Allowed values are 50-5000. Unit is MILLISECONDS. format: int64

Parameters:

minRexmtTimeout - New value for the property.

setNaglesAlgorithm

public ALBTCPProxyProfile.Builder setNaglesAlgorithm(java.lang.Boolean naglesAlgorithm)

Consolidates small data packets to send clients fewer but larger packets. Adversely affects real time protocols such as telnet or SSH. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

naglesAlgorithm - New value for the property.

setReassemblyQueueSize

public ALBTCPProxyProfile.Builder setReassemblyQueueSize(java.lang.Long reassemblyQueueSize)

Maximum number of TCP segments that can be queued for reassembly. Configuring this to 0 disables the feature and provides unlimited queuing. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

reassemblyQueueSize - New value for the property.

setReceiveWindow

public ALBTCPProxyProfile.Builder setReceiveWindow(java.lang.Long receiveWindow)

Size of the receive window. Allowed values are 2-65536. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 64. format: int64

Parameters:

receiveWindow - New value for the property.

setReorderThreshold

public ALBTCPProxyProfile.Builder setReorderThreshold(java.lang.Long reorderThreshold)

Controls the number of duplicate acks required to trigger retransmission. Setting a higher value reduces retransmission caused by packet reordering. A larger value is recommended in public cloud environments where packet reordering is quite common. The default value is 8 in public cloud platforms (AWS, Azure, GCP), and 3 in other environments. Allowed values are 1-100. format: int64

Parameters:

reorderThreshold - New value for the property.

setSlowStartScalingFactor

public ALBTCPProxyProfile.Builder setSlowStartScalingFactor(java.lang.Long slowStartScalingFactor)

Congestion window scaling factor during slow start. Allowed values are 0-8. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64

Parameters:

slowStartScalingFactor - New value for the property.

setTimeWaitDelay

public ALBTCPProxyProfile.Builder setTimeWaitDelay(java.lang.Long timeWaitDelay)

The time (in millisec) to wait before closing a connection in the TIME_WAIT state. Allowed values are 500-2000. Special values are 0 - 'immediate'. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 2000. format: int64

Parameters:

timeWaitDelay - New value for the property.

setUseInterfaceMtu

public ALBTCPProxyProfile.Builder setUseInterfaceMtu(java.lang.Boolean useInterfaceMtu)

Use the interface MTU to calculate the TCP max segment size. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

useInterfaceMtu - New value for the property.

build

public ALBTCPProxyProfile build()