com.vmware.nsx_global_policy.model

Class LBRule.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.LBRule.Builder

Enclosing class:

LBRule

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

Builder class for LBRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LBRule	build()
LBRule.Builder	setActions(java.util.List<com.vmware.vapi.bindings.Structure> actions) A list of actions to be executed at specified phase when load balancer rule matches.
LBRule.Builder	setDisplayName(java.lang.String displayName) A display name useful for identifying an LBRule.
LBRule.Builder	setMatchConditions(java.util.List<com.vmware.vapi.bindings.Structure> matchConditions) A list of match conditions used to match application traffic.
LBRule.Builder	setMatchStrategy(java.lang.String matchStrategy) Possible values are: LBRule.MATCH_STRATEGY_ALL LBRule.MATCH_STRATEGY_ANY If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match.
LBRule.Builder	setPhase(java.lang.String phase) Possible values are: LBRule.PHASE_HTTP_REQUEST_REWRITE LBRule.PHASE_HTTP_FORWARDING LBRule.PHASE_HTTP_RESPONSE_REWRITE LBRule.PHASE_HTTP_ACCESS LBRule.PHASE_TRANSPORT Each load balancer rule is used at a specific phase of load balancer processing.

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

Method Detail

setActions

public LBRule.Builder setActions(java.util.List<com.vmware.vapi.bindings.Structure> actions)

A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc.

Parameters:

actions - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LBRuleAction. When methods return a value of this class as a return value, the property will contain all the properties defined in LBRuleAction.

setDisplayName

public LBRule.Builder setDisplayName(java.lang.String displayName)

A display name useful for identifying an LBRule.

Parameters:

displayName - New value for the property.

setMatchConditions

public LBRule.Builder setMatchConditions(java.util.List<com.vmware.vapi.bindings.Structure> matchConditions)

A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match.

Parameters:

matchConditions - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LBRuleCondition. When methods return a value of this class as a return value, the property will contain all the properties defined in LBRuleCondition.

setMatchStrategy

public LBRule.Builder setMatchStrategy(java.lang.String matchStrategy)

Possible values are:

• LBRule.MATCH_STRATEGY_ALL
• LBRule.MATCH_STRATEGY_ANY

If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this LBRule to be considered a match. - ANY indicates that either host_match or patch match may match for this LBRule to be considered a match.

Parameters:

matchStrategy - New value for the property.

setPhase

public LBRule.Builder setPhase(java.lang.String phase)

Possible values are:

• LBRule.PHASE_HTTP_REQUEST_REWRITE
• LBRule.PHASE_HTTP_FORWARDING
• LBRule.PHASE_HTTP_RESPONSE_REWRITE
• LBRule.PHASE_HTTP_ACCESS
• LBRule.PHASE_TRANSPORT

Each load balancer rule is used at a specific phase of load balancer processing. Currently five phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING, HTTP_RESPONSE_REWRITE, HTTP_ACCESS and TRANSPORT. When an HTTP request message is received by load balancer, all HTTP_REQUEST_REWRITE rules, if present are executed in the order they are applied to virtual server. And then if HTTP_FORWARDING rules present, only first matching rule's action is executed, remaining rules are not checked. HTTP_FORWARDING rules can have only one action. If the request is forwarded to a backend server and the response goes back to load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed in the order they are applied to the virtual server. In HTTP_ACCESS phase, user can define action to control access using JWT authentication. In TRANSPORT phase, user can define the condition to match SNI in TLS client hello and define the action to do SSL end-to-end, SSL offloading or SSL passthrough using a specific load balancer server pool.

Parameters:

phase - New value for the property.

build

public LBRule build()