com.vmware.nsx.model

Class LbPool.Builder

java.lang.Object

com.vmware.nsx.model.LbPool.Builder

Enclosing class:

LbPool

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

Builder class for LbPool.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LbPool	build()
LbPool.Builder	setActiveMonitorIds(java.util.List<java.lang.String> activeMonitorIds) In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic.
LbPool.Builder	setAlgorithm(java.lang.String algorithm) Possible values are: LbPool.ALGORITHM_ROUND_ROBIN LbPool.ALGORITHM_WEIGHTED_ROUND_ROBIN LbPool.ALGORITHM_LEAST_CONNECTION LbPool.ALGORITHM_WEIGHTED_LEAST_CONNECTION LbPool.ALGORITHM_IP_HASH Load balancing algorithm, configurable per pool controls how the incoming connections are distributed among the members.
LbPool.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.
LbPool.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.
LbPool.Builder	setDescription(java.lang.String description) Description of this resource
LbPool.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LbPool.Builder	setId(java.lang.String id) Unique identifier of this resource
LbPool.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.
LbPool.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.
LbPool.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LbPool.Builder	setMemberGroup(PoolMemberGroup memberGroup)
LbPool.Builder	setMembers(java.util.List<PoolMember> members) Server pool consists of one or more pool members.
LbPool.Builder	setMinActiveMembers(java.lang.Long minActiveMembers) A pool is considered active if there are at least certain minimum number of members.
LbPool.Builder	setPassiveMonitorId(java.lang.String passiveMonitorId) Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool.
LbPool.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.
LbPool.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LbPool.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LbPool.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.
LbPool.Builder	setSelf(SelfResourceLink self)
LbPool.Builder	setSnatTranslation(com.vmware.vapi.bindings.Structure snatTranslation)
LbPool.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.
LbPool.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LbPool.Builder	setTcpMultiplexingEnabled(java.lang.Boolean tcpMultiplexingEnabled) TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections.
LbPool.Builder	setTcpMultiplexingNumber(java.lang.Long tcpMultiplexingNumber) The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.

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

Method Detail

setLinks

public LbPool.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 LbPool.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 LbPool.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public LbPool.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 LbPool.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 LbPool.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 LbPool.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 LbPool.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 LbPool.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 LbPool.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 LbPool.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setActiveMonitorIds

public LbPool.Builder setActiveMonitorIds(java.util.List<java.lang.String> activeMonitorIds)

In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. If multiple active monitors are configured, the pool member status is UP only when the health check status for all the monitors are UP. The property is deprecated as NSX-T Load Balancer is deprecated.

Parameters:

activeMonitorIds - New value for the property.

setAlgorithm

public LbPool.Builder setAlgorithm(java.lang.String algorithm)

Possible values are:

• LbPool.ALGORITHM_ROUND_ROBIN
• LbPool.ALGORITHM_WEIGHTED_ROUND_ROBIN
• LbPool.ALGORITHM_LEAST_CONNECTION
• LbPool.ALGORITHM_WEIGHTED_LEAST_CONNECTION
• LbPool.ALGORITHM_IP_HASH

Load balancing algorithm, configurable per pool controls how the incoming connections are distributed among the members.

Parameters:

algorithm - New value for the property.

setMemberGroup

public LbPool.Builder setMemberGroup(PoolMemberGroup memberGroup)

Parameters:

memberGroup - New value for the property.

setMembers

public LbPool.Builder setMembers(java.util.List<PoolMember> members)

Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.

Parameters:

members - New value for the property.

setMinActiveMembers

public LbPool.Builder setMinActiveMembers(java.lang.Long minActiveMembers)

A pool is considered active if there are at least certain minimum number of members. format: int64

Parameters:

minActiveMembers - New value for the property.

setPassiveMonitorId

public LbPool.Builder setPassiveMonitorId(java.lang.String passiveMonitorId)

Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented. The property is deprecated as NSX-T Load Balancer is deprecated.

Parameters:

passiveMonitorId - New value for the property.

setSnatTranslation

public LbPool.Builder setSnatTranslation(com.vmware.vapi.bindings.Structure snatTranslation)

Parameters:

snatTranslation - 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 LbSnatTranslation. When methods return a value of this class as a return value, the property will contain all the properties defined in LbSnatTranslation.

setTcpMultiplexingEnabled

public LbPool.Builder setTcpMultiplexingEnabled(java.lang.Boolean tcpMultiplexingEnabled)

TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. The property is deprecated as NSX-T Load Balancer is deprecated.

Parameters:

tcpMultiplexingEnabled - New value for the property.

setTcpMultiplexingNumber

public LbPool.Builder setTcpMultiplexingNumber(java.lang.Long tcpMultiplexingNumber)

The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The property is deprecated as NSX-T Load Balancer is deprecated. format: int64

Parameters:

tcpMultiplexingNumber - New value for the property.

build

public LbPool build()