com.vmware.nsx_policy.model

Class LBPool.Builder

java.lang.Object

com.vmware.nsx_policy.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	setActiveMonitorPaths(java.util.List<java.lang.String> activeMonitorPaths) 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 chooses a server for each new connection by going through the list of servers in the pool.
LBPool.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
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	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LBPool.Builder	setMemberGroup(LBPoolMemberGroup memberGroup)
LBPool.Builder	setMembers(java.util.List<LBPoolMember> 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	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LBPool.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LBPool.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
LBPool.Builder	setParentPath(java.lang.String parentPath) Path of its parent 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	setPassiveMonitorPath(java.lang.String passiveMonitorPath) Passive healthchecks are deactivated by default and can be activated by attaching a passive health monitor to a server pool.
LBPool.Builder	setPath(java.lang.String path) Absolute path of this object 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	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	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LBPool.Builder	setRelativePath(java.lang.String relativePath) Path relative from its parent 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	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
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.
LBPool.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.

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.

setOriginSiteId

public LBPool.Builder setOriginSiteId(java.lang.String originSiteId)

This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:

originSiteId - New value for the property.

setOwnerId

public LBPool.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:

ownerId - New value for the property.

setParentPath

public LBPool.Builder setParentPath(java.lang.String parentPath)

Path of its parent 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:

parentPath - New value for the property.

setPath

public LBPool.Builder setPath(java.lang.String path)

Absolute path of this object 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:

path - New value for the property.

setRealizationId

public LBPool.Builder setRealizationId(java.lang.String realizationId)

This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:

realizationId - New value for the property.

setRelativePath

public LBPool.Builder setRelativePath(java.lang.String relativePath)

Path relative from its parent 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:

relativePath - New value for the property.

setRemotePath

public LBPool.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:

remotePath - New value for the property.

setUniqueId

public LBPool.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:

uniqueId - New value for the property.

setChildren

public LBPool.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)

Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.

Parameters:

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

setMarkedForDelete

public LBPool.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:

markedForDelete - New value for the property.

setOverridden

public LBPool.Builder setOverridden(java.lang.Boolean overridden)

Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:

overridden - New value for the property.

setActiveMonitorPaths

public LBPool.Builder setActiveMonitorPaths(java.util.List<java.lang.String> activeMonitorPaths)

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 deactivated by default and can be activated 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:

activeMonitorPaths - 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 chooses a server for each new connection by going through the list of servers in the pool. Currently, following load balancing algorithms are supported with ROUND_ROBIN as the default. ROUND_ROBIN means that a server is selected in a round-robin fashion. The weight would be ignored even if it is configured. WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted round-robin fashion. Default weight of 1 is used if weight is not configured. LEAST_CONNECTION means that a server is selected when it has the least number of connections. The weight would be ignored even if it is configured. Slow start would be enabled by default. WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted least connection fashion. Default weight of 1 is used if weight is not configured. Slow start would be enabled by default. IP_HASH means that consistent hash is performed on the source IP address of the incoming connection. This ensures that the same client IP address will always reach the same server as long as no server goes down or up. It may be used on the Internet to provide a best-effort stickiness to clients which refuse session cookies.

Parameters:

algorithm - New value for the property.

setMemberGroup

public LBPool.Builder setMemberGroup(LBPoolMemberGroup memberGroup)

Parameters:

memberGroup - New value for the property.

setMembers

public LBPool.Builder setMembers(java.util.List<LBPoolMember> 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.

setPassiveMonitorPath

public LBPool.Builder setPassiveMonitorPath(java.lang.String passiveMonitorPath)

Passive healthchecks are deactivated by default and can be activated 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:

passiveMonitorPath - 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()