com.vmware.nsx.model

Class LbRule.Builder

java.lang.Object

com.vmware.nsx.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	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setDescription(java.lang.String description) Description of this resource
LbRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LbRule.Builder	setId(java.lang.String id) Unique identifier of this resource
LbRule.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
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 Strategy to define how load balancer rule is considered a match when multiple match conditions are specified in one rule.
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.
LbRule.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
LbRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LbRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LbRule.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setSelf(SelfResourceLink self)
LbRule.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LbRule.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

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

setLinks

public LbRule.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public LbRule.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public LbRule.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public LbRule.Builder setRevision(java.lang.Long revision)

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public LbRule.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public LbRule.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public LbRule.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public LbRule.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public LbRule.Builder setProtection(java.lang.String protection)

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public LbRule.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public LbRule.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public LbRule.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public LbRule.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public LbRule.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

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.

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

Strategy to define how load balancer rule is considered a match when multiple match conditions are specified in one rule. If match_stragety is set to ALL, then load balancer rule is considered a match only if all the conditions match. If match_strategy is set to ANY, then load balancer rule is considered a match if any one of the conditions 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()