com.vmware.nsx_global_policy.model

Class ALBPool.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBPool.Builder

Enclosing class:

ALBPool

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

Builder class for ALBPool.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBPool	build()
ALBPool.Builder	setAnalyticsPolicy(ALBPoolAnalyticsPolicy analyticsPolicy)
ALBPool.Builder	setAnalyticsProfilePath(java.lang.String analyticsProfilePath) Specifies settings related to analytics.
ALBPool.Builder	setApicEpgName(java.lang.String apicEpgName) Synchronize Cisco APIC EPG members with pool servers.
ALBPool.Builder	setApplicationPersistenceProfilePath(java.lang.String applicationPersistenceProfilePath) Persistence will ensure the same user sticks to the same server for a desired duration of time.
ALBPool.Builder	setAutoscaleLaunchConfigPath(java.lang.String autoscaleLaunchConfigPath) If configured then Avi will trigger orchestration of pool server creation and deletion.
ALBPool.Builder	setAutoscaleNetworks(java.util.List<java.lang.String> autoscaleNetworks) Network Ids for the launch configuration.
ALBPool.Builder	setAutoscalePolicyPath(java.lang.String autoscalePolicyPath) Reference to Server Autoscale Policy.
ALBPool.Builder	setCapacityEstimation(java.lang.Boolean capacityEstimation) Inline estimation of capacity of servers.
ALBPool.Builder	setCapacityEstimationTtfbThresh(java.lang.Long capacityEstimationTtfbThresh) The maximum time-to-first-byte of a server.
ALBPool.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBPool.Builder	setCloudConfigCksum(java.lang.String cloudConfigCksum) Checksum of cloud configuration for Pool.
ALBPool.Builder	setCloudName(java.lang.String cloudName) It is a reference to an object of type Cloud.
ALBPool.Builder	setConnectionRampDuration(java.lang.Long connectionRampDuration) Duration for which new connections will be gradually ramped up to a server recently brought online.
ALBPool.Builder	setConnPoolProperties(ALBConnPoolProperties connPoolProperties)
ALBPool.Builder	setCreatedBy(java.lang.String createdBy) Creator name.
ALBPool.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.
ALBPool.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.
ALBPool.Builder	setDefaultServerPort(java.lang.Long defaultServerPort) Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute.
ALBPool.Builder	setDeleteServerOnDnsRefresh(java.lang.Boolean deleteServerOnDnsRefresh) Indicates whether existing IPs are disabled(false) or deleted(true) on dns hostname refreshDetail -- On a dns refresh, some IPs set on pool may no longer be returned by the resolver.
ALBPool.Builder	setDescription(java.lang.String description) Description of this resource
ALBPool.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBPool.Builder	setDomainName(java.util.List<java.lang.String> domainName) Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates.
ALBPool.Builder	setEastWest(java.lang.Boolean eastWest) Inherited config from VirtualService.
ALBPool.Builder	setEnabled(java.lang.Boolean enabled) Enable or disable the pool.
ALBPool.Builder	setEnableHttp2(java.lang.Boolean enableHttp2) Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool.
ALBPool.Builder	setExternalAutoscaleGroups(java.util.List<java.lang.String> externalAutoscaleGroups) Names of external auto-scale groups for pool servers.
ALBPool.Builder	setFailAction(ALBFailAction failAction)
ALBPool.Builder	setFewestTasksFeedbackDelay(java.lang.Long fewestTasksFeedbackDelay) Periodicity of feedback for fewest tasks server selection algorithm.
ALBPool.Builder	setGracefulDisableTimeout(java.lang.Long gracefulDisableTimeout) Used to gracefully disable a server.
ALBPool.Builder	setGroupPaths(java.util.List<java.lang.String> groupPaths) A list of NSX Groups where the Servers for the Pool are created .
ALBPool.Builder	setGslbSpEnabled(java.lang.Boolean gslbSpEnabled) Indicates if the pool is a site-persistence pool.
ALBPool.Builder	setHealthMonitorPaths(java.util.List<java.lang.String> healthMonitorPaths) Verify server health by applying one or more health monitors.
ALBPool.Builder	setHostCheckEnabled(java.lang.Boolean hostCheckEnabled) Enable common name check for server certificate.
ALBPool.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBPool.Builder	setIgnoreServerPort(java.lang.Boolean ignoreServerPort) Ignore the server port in building the load balancing state.Applicable only for consistent hash load balancing algorithm or Disable Port translation (use_service_port) use cases.
ALBPool.Builder	setInlineHealthMonitor(java.lang.Boolean inlineHealthMonitor) The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses.
ALBPool.Builder	setIpaddrgroupPath(java.lang.String ipaddrgroupPath) Use list of servers from Ip Address Group.
ALBPool.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.
ALBPool.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.
ALBPool.Builder	setLbAlgorithm(java.lang.String lbAlgorithm) Possible values are: ALBPool.LB_ALGORITHM_LEAST_CONNECTIONS ALBPool.LB_ALGORITHM_ROUND_ROBIN ALBPool.LB_ALGORITHM_FASTEST_RESPONSE ALBPool.LB_ALGORITHM_CONSISTENT_HASH ALBPool.LB_ALGORITHM_LEAST_LOAD ALBPool.LB_ALGORITHM_FEWEST_SERVERS ALBPool.LB_ALGORITHM_RANDOM ALBPool.LB_ALGORITHM_FEWEST_TASKS ALBPool.LB_ALGORITHM_NEAREST_SERVER ALBPool.LB_ALGORITHM_CORE_AFFINITY ALBPool.LB_ALGORITHM_TOPOLOGY The load balancing algorithm will pick a server within the pool's list of available servers.
ALBPool.Builder	setLbAlgorithmConsistentHashHdr(java.lang.String lbAlgorithmConsistentHashHdr) HTTP header name to be used for the hash key.
ALBPool.Builder	setLbAlgorithmCoreNonaffinity(java.lang.Long lbAlgorithmCoreNonaffinity) Degree of non-affinity for core affinity based server selection.
ALBPool.Builder	setLbAlgorithmHash(java.lang.String lbAlgorithmHash) Possible values are: ALBPool.LB_ALGORITHM_HASH_SOURCE_IP_ADDRESS ALBPool.LB_ALGORITHM_HASH_SOURCE_IP_ADDRESS_AND_PORT ALBPool.LB_ALGORITHM_HASH_URI ALBPool.LB_ALGORITHM_HASH_CUSTOM_HEADER ALBPool.LB_ALGORITHM_HASH_CUSTOM_STRING ALBPool.LB_ALGORITHM_HASH_CALLID Criteria used as a key for determining the hash between the client and server.
ALBPool.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBPool.Builder	setLookupServerByName(java.lang.Boolean lookupServerByName) Allow server lookup by name.
ALBPool.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBPool.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBPool.Builder	setMaxConcurrentConnectionsPerServer(java.lang.Long maxConcurrentConnectionsPerServer) The maximum number of concurrent connections allowed to each server within the pool.
ALBPool.Builder	setMaxConnRatePerServer(ALBRateProfile maxConnRatePerServer)
ALBPool.Builder	setMinHealthMonitorsUp(java.lang.Long minHealthMonitorsUp) Minimum number of health monitors in UP state to mark server UP.
ALBPool.Builder	setMinServersUp(java.lang.Long minServersUp) Minimum number of servers in UP state for marking the pool UP.
ALBPool.Builder	setNetworks(java.util.List<ALBNetworkFilter> networks) (internal-use) Networks designated as containing servers for this pool.
ALBPool.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBPool.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBPool.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBPool.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.
ALBPool.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.
ALBPool.Builder	setPkiProfilePath(java.lang.String pkiProfilePath) Avi will validate the SSL certificate present by a server against the selected PKI Profile.
ALBPool.Builder	setPlacementNetworks(java.util.List<ALBPlacementNetwork> placementNetworks) Manually select the networks and subnets used to provide reachability to the pool's servers.
ALBPool.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.
ALBPool.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBPool.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.
ALBPool.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
ALBPool.Builder	setRequestQueueDepth(java.lang.Long requestQueueDepth) Minimum number of requests to be queued when pool is full.
ALBPool.Builder	setRequestQueueEnabled(java.lang.Boolean requestQueueEnabled) Enable request queue when pool is full.
ALBPool.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBPool.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBPool.Builder	setRewriteHostHeaderToServerName(java.lang.Boolean rewriteHostHeaderToServerName) Rewrite incoming Host Header to server name of the server to which the request is proxied.
ALBPool.Builder	setRewriteHostHeaderToSni(java.lang.Boolean rewriteHostHeaderToSni) If SNI server name is specified, rewrite incoming host header to the SNI server name.
ALBPool.Builder	setRoutingPool(java.lang.Boolean routingPool) Enable to do routing when this pool is selected to send traffic.
ALBPool.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.
ALBPool.Builder	setSelf(SelfResourceLink self)
ALBPool.Builder	setServerName(java.lang.String serverName) Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled.
ALBPool.Builder	setServerReselect(ALBHTTPServerReselect serverReselect)
ALBPool.Builder	setServers(java.util.List<ALBServer> servers) The pool directs load balanced traffic to this list of destination servers.
ALBPool.Builder	setServerTimeout(java.lang.Long serverTimeout) Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between AVI and the server.
ALBPool.Builder	setServiceMetadata(java.lang.String serviceMetadata) Metadata pertaining to the service provided by this Pool.
ALBPool.Builder	setSniEnabled(java.lang.Boolean sniEnabled) Enable TLS SNI for server connections.
ALBPool.Builder	setSslKeyAndCertificatePath(java.lang.String sslKeyAndCertificatePath) Service Engines will present a client SSL certificate to the server.
ALBPool.Builder	setSslProfilePath(java.lang.String sslProfilePath) When enabled, Avi re-encrypts traffic to the backend servers.
ALBPool.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.
ALBPool.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBPool.Builder	setTier1Path(java.lang.String tier1Path) This tier1_lr field should be set same as VirtualService associated for NSX-T.
ALBPool.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
ALBPool.Builder	setUseServicePort(java.lang.Boolean useServicePort) Do not translate the client's destination port when sending the connection to the server.
ALBPool.Builder	setVrfName(java.lang.String vrfName) Virtual Routing Context that the pool is bound to.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBPool.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 Pmaas 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 ALBPool.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas 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 ALBPool.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 ALBPool.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 ALBPool.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 thier 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 ALBPool.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 ALBPool.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS 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 ALBPool.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entites 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 ALBPool.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 ALBPool.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 ALBPool.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.

setAnalyticsPolicy

public ALBPool.Builder setAnalyticsPolicy(ALBPoolAnalyticsPolicy analyticsPolicy)

Parameters:

analyticsPolicy - New value for the property.

setAnalyticsProfilePath

public ALBPool.Builder setAnalyticsProfilePath(java.lang.String analyticsProfilePath)

Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.

Parameters:

analyticsProfilePath - New value for the property.

setApicEpgName

public ALBPool.Builder setApicEpgName(java.lang.String apicEpgName)

Synchronize Cisco APIC EPG members with pool servers.

Parameters:

apicEpgName - New value for the property.

setApplicationPersistenceProfilePath

public ALBPool.Builder setApplicationPersistenceProfilePath(java.lang.String applicationPersistenceProfilePath)

Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type ApplicationPersistenceProfile.

Parameters:

applicationPersistenceProfilePath - New value for the property.

setAutoscaleLaunchConfigPath

public ALBPool.Builder setAutoscaleLaunchConfigPath(java.lang.String autoscaleLaunchConfigPath)

If configured then Avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type AutoScaleLaunchConfig.

Parameters:

autoscaleLaunchConfigPath - New value for the property.

setAutoscaleNetworks

public ALBPool.Builder setAutoscaleNetworks(java.util.List<java.lang.String> autoscaleNetworks)

Network Ids for the launch configuration.

Parameters:

autoscaleNetworks - New value for the property.

setAutoscalePolicyPath

public ALBPool.Builder setAutoscalePolicyPath(java.lang.String autoscalePolicyPath)

Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy.

Parameters:

autoscalePolicyPath - New value for the property.

setCapacityEstimation

public ALBPool.Builder setCapacityEstimation(java.lang.Boolean capacityEstimation)

Inline estimation of capacity of servers. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

capacityEstimation - New value for the property.

setCapacityEstimationTtfbThresh

public ALBPool.Builder setCapacityEstimationTtfbThresh(java.lang.Long capacityEstimationTtfbThresh)

The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - 'Automatic'. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

capacityEstimationTtfbThresh - New value for the property.

setCloudConfigCksum

public ALBPool.Builder setCloudConfigCksum(java.lang.String cloudConfigCksum)

Checksum of cloud configuration for Pool. Internally set by cloud connector.

Parameters:

cloudConfigCksum - New value for the property.

setCloudName

public ALBPool.Builder setCloudName(java.lang.String cloudName)

It is a reference to an object of type Cloud.

Parameters:

cloudName - New value for the property.

setConnPoolProperties

public ALBPool.Builder setConnPoolProperties(ALBConnPoolProperties connPoolProperties)

Parameters:

connPoolProperties - New value for the property.

setConnectionRampDuration

public ALBPool.Builder setConnectionRampDuration(java.lang.Long connectionRampDuration)

Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for LB algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - 'Immediate'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 10. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

connectionRampDuration - New value for the property.

setCreatedBy

public ALBPool.Builder setCreatedBy(java.lang.String createdBy)

Creator name.

Parameters:

createdBy - New value for the property.

setDefaultServerPort

public ALBPool.Builder setDefaultServerPort(java.lang.Long defaultServerPort)

Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption. Allowed values are 1-65535. Default value when not specified in API or module is interpreted by ALB Controller as 80. format: int64

Parameters:

defaultServerPort - New value for the property.

setDeleteServerOnDnsRefresh

public ALBPool.Builder setDeleteServerOnDnsRefresh(java.lang.Boolean deleteServerOnDnsRefresh)

Indicates whether existing IPs are disabled(false) or deleted(true) on dns hostname refreshDetail -- On a dns refresh, some IPs set on pool may no longer be returned by the resolver. These IPs are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

deleteServerOnDnsRefresh - New value for the property.

setDomainName

public ALBPool.Builder setDomainName(java.util.List<java.lang.String> domainName)

Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled.

Parameters:

domainName - New value for the property.

setEastWest

public ALBPool.Builder setEastWest(java.lang.Boolean eastWest)

Inherited config from VirtualService.

Parameters:

eastWest - New value for the property.

setEnableHttp2

public ALBPool.Builder setEnableHttp2(java.lang.Boolean enableHttp2)

Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

enableHttp2 - New value for the property.

setEnabled

public ALBPool.Builder setEnabled(java.lang.Boolean enabled)

Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

enabled - New value for the property.

setExternalAutoscaleGroups

public ALBPool.Builder setExternalAutoscaleGroups(java.util.List<java.lang.String> externalAutoscaleGroups)

Names of external auto-scale groups for pool servers. Currently available only for AWS and Azure.

Parameters:

externalAutoscaleGroups - New value for the property.

setFailAction

public ALBPool.Builder setFailAction(ALBFailAction failAction)

Parameters:

failAction - New value for the property.

setFewestTasksFeedbackDelay

public ALBPool.Builder setFewestTasksFeedbackDelay(java.lang.Long fewestTasksFeedbackDelay)

Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64

Parameters:

fewestTasksFeedbackDelay - New value for the property.

setGracefulDisableTimeout

public ALBPool.Builder setGracefulDisableTimeout(java.lang.Long gracefulDisableTimeout)

Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - 'Immediate', -1 - 'Infinite'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64

Parameters:

gracefulDisableTimeout - New value for the property.

setGroupPaths

public ALBPool.Builder setGroupPaths(java.util.List<java.lang.String> groupPaths)

A list of NSX Groups where the Servers for the Pool are created .

Parameters:

groupPaths - New value for the property.

setGslbSpEnabled

public ALBPool.Builder setGslbSpEnabled(java.lang.Boolean gslbSpEnabled)

Indicates if the pool is a site-persistence pool. Allowed in Basic edition, Essentials edition, Enterprise edition.

Parameters:

gslbSpEnabled - New value for the property.

setHealthMonitorPaths

public ALBPool.Builder setHealthMonitorPaths(java.util.List<java.lang.String> healthMonitorPaths)

Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each Service Engine and mark a server up or down based on the response. The Passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type HealthMonitor. Maximum of 50 items allowed.

Parameters:

healthMonitorPaths - New value for the property.

setHostCheckEnabled

public ALBPool.Builder setHostCheckEnabled(java.lang.Boolean hostCheckEnabled)

Enable common name check for server certificate. If enabled and no explicit domain name is specified, Avi will use the incoming host header to do the match. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

hostCheckEnabled - New value for the property.

setIgnoreServerPort

public ALBPool.Builder setIgnoreServerPort(java.lang.Boolean ignoreServerPort)

Ignore the server port in building the load balancing state.Applicable only for consistent hash load balancing algorithm or Disable Port translation (use_service_port) use cases. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

ignoreServerPort - New value for the property.

setInlineHealthMonitor

public ALBPool.Builder setInlineHealthMonitor(java.lang.Boolean inlineHealthMonitor)

The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

inlineHealthMonitor - New value for the property.

setIpaddrgroupPath

public ALBPool.Builder setIpaddrgroupPath(java.lang.String ipaddrgroupPath)

Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup.

Parameters:

ipaddrgroupPath - New value for the property.

setLbAlgorithm

public ALBPool.Builder setLbAlgorithm(java.lang.String lbAlgorithm)

Possible values are:

• ALBPool.LB_ALGORITHM_LEAST_CONNECTIONS
• ALBPool.LB_ALGORITHM_ROUND_ROBIN
• ALBPool.LB_ALGORITHM_FASTEST_RESPONSE
• ALBPool.LB_ALGORITHM_CONSISTENT_HASH
• ALBPool.LB_ALGORITHM_LEAST_LOAD
• ALBPool.LB_ALGORITHM_FEWEST_SERVERS
• ALBPool.LB_ALGORITHM_RANDOM
• ALBPool.LB_ALGORITHM_FEWEST_TASKS
• ALBPool.LB_ALGORITHM_NEAREST_SERVER
• ALBPool.LB_ALGORITHM_CORE_AFFINITY
• ALBPool.LB_ALGORITHM_TOPOLOGY

The load balancing algorithm will pick a server within the pool's list of available servers. Values LB_ALGORITHM_NEAREST_SERVER and LB_ALGORITHM_TOPOLOGY are only allowed for GSLB pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed in Basic(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Essentials(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_LEAST_CONNECTIONS.

Parameters:

lbAlgorithm - New value for the property.

setLbAlgorithmConsistentHashHdr

public ALBPool.Builder setLbAlgorithmConsistentHashHdr(java.lang.String lbAlgorithmConsistentHashHdr)

HTTP header name to be used for the hash key.

Parameters:

lbAlgorithmConsistentHashHdr - New value for the property.

setLbAlgorithmCoreNonaffinity

public ALBPool.Builder setLbAlgorithmCoreNonaffinity(java.lang.Long lbAlgorithmCoreNonaffinity)

Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2. format: int64

Parameters:

lbAlgorithmCoreNonaffinity - New value for the property.

setLbAlgorithmHash

public ALBPool.Builder setLbAlgorithmHash(java.lang.String lbAlgorithmHash)

Possible values are:

• ALBPool.LB_ALGORITHM_HASH_SOURCE_IP_ADDRESS
• ALBPool.LB_ALGORITHM_HASH_SOURCE_IP_ADDRESS_AND_PORT
• ALBPool.LB_ALGORITHM_HASH_URI
• ALBPool.LB_ALGORITHM_HASH_CUSTOM_HEADER
• ALBPool.LB_ALGORITHM_HASH_CUSTOM_STRING
• ALBPool.LB_ALGORITHM_HASH_CALLID

Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed in Basic(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Essentials(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.

Parameters:

lbAlgorithmHash - New value for the property.

setLookupServerByName

public ALBPool.Builder setLookupServerByName(java.lang.Boolean lookupServerByName)

Allow server lookup by name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

lookupServerByName - New value for the property.

setMarkers

public ALBPool.Builder setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers)

List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.

Parameters:

markers - New value for the property.

setMaxConcurrentConnectionsPerServer

public ALBPool.Builder setMaxConcurrentConnectionsPerServer(java.lang.Long maxConcurrentConnectionsPerServer)

The maximum number of concurrent connections allowed to each server within the pool. NOTE applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

maxConcurrentConnectionsPerServer - New value for the property.

setMaxConnRatePerServer

public ALBPool.Builder setMaxConnRatePerServer(ALBRateProfile maxConnRatePerServer)

Parameters:

maxConnRatePerServer - New value for the property.

setMinHealthMonitorsUp

public ALBPool.Builder setMinHealthMonitorsUp(java.lang.Long minHealthMonitorsUp)

Minimum number of health monitors in UP state to mark server UP. Allowed in Basic edition, Essentials edition, Enterprise edition. format: int64

Parameters:

minHealthMonitorsUp - New value for the property.

setMinServersUp

public ALBPool.Builder setMinServersUp(java.lang.Long minServersUp)

Minimum number of servers in UP state for marking the pool UP. format: int64

Parameters:

minServersUp - New value for the property.

setNetworks

public ALBPool.Builder setNetworks(java.util.List<ALBNetworkFilter> networks)

(internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user.

Parameters:

networks - New value for the property.

setPkiProfilePath

public ALBPool.Builder setPkiProfilePath(java.lang.String pkiProfilePath)

Avi will validate the SSL certificate present by a server against the selected PKI Profile. It is a reference to an object of type PKIProfile.

Parameters:

pkiProfilePath - New value for the property.

setPlacementNetworks

public ALBPool.Builder setPlacementNetworks(java.util.List<ALBPlacementNetwork> placementNetworks)

Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax 10-1-1-0/24. Use static routes in VRF configuration when pool servers are not directly connected but routable from the service engine.

Parameters:

placementNetworks - New value for the property.

setRequestQueueDepth

public ALBPool.Builder setRequestQueueDepth(java.lang.Long requestQueueDepth)

Minimum number of requests to be queued when pool is full. Allowed in Basic(Allowed values- 128) edition, Essentials(Allowed values- 128) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 128. format: int64

Parameters:

requestQueueDepth - New value for the property.

setRequestQueueEnabled

public ALBPool.Builder setRequestQueueEnabled(java.lang.Boolean requestQueueEnabled)

Enable request queue when pool is full. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

requestQueueEnabled - New value for the property.

setRewriteHostHeaderToServerName

public ALBPool.Builder setRewriteHostHeaderToServerName(java.lang.Boolean rewriteHostHeaderToServerName)

Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

rewriteHostHeaderToServerName - New value for the property.

setRewriteHostHeaderToSni

public ALBPool.Builder setRewriteHostHeaderToSni(java.lang.Boolean rewriteHostHeaderToSni)

If SNI server name is specified, rewrite incoming host header to the SNI server name. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

rewriteHostHeaderToSni - New value for the property.

setRoutingPool

public ALBPool.Builder setRoutingPool(java.lang.Boolean routingPool)

Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

routingPool - New value for the property.

setServerName

public ALBPool.Builder setServerName(java.lang.String serverName)

Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead.

Parameters:

serverName - New value for the property.

setServerReselect

public ALBPool.Builder setServerReselect(ALBHTTPServerReselect serverReselect)

Parameters:

serverReselect - New value for the property.

setServerTimeout

public ALBPool.Builder setServerTimeout(java.lang.Long serverTimeout)

Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between AVI and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

serverTimeout - New value for the property.

setServers

public ALBPool.Builder setServers(java.util.List<ALBServer> servers)

The pool directs load balanced traffic to this list of destination servers. The servers can be configured by IP address, name, network or via IP Address Group. Maximum of 5000 items allowed.

Parameters:

servers - New value for the property.

setServiceMetadata

public ALBPool.Builder setServiceMetadata(java.lang.String serviceMetadata)

Metadata pertaining to the service provided by this Pool. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage.

Parameters:

serviceMetadata - New value for the property.

setSniEnabled

public ALBPool.Builder setSniEnabled(java.lang.Boolean sniEnabled)

Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

sniEnabled - New value for the property.

setSslKeyAndCertificatePath

public ALBPool.Builder setSslKeyAndCertificatePath(java.lang.String sslKeyAndCertificatePath)

Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.

Parameters:

sslKeyAndCertificatePath - New value for the property.

setSslProfilePath

public ALBPool.Builder setSslProfilePath(java.lang.String sslProfilePath)

When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. It is a reference to an object of type SSLProfile.

Parameters:

sslProfilePath - New value for the property.

setTier1Path

public ALBPool.Builder setTier1Path(java.lang.String tier1Path)

This tier1_lr field should be set same as VirtualService associated for NSX-T.

Parameters:

tier1Path - New value for the property.

setUseServicePort

public ALBPool.Builder setUseServicePort(java.lang.Boolean useServicePort)

Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

useServicePort - New value for the property.

setVrfName

public ALBPool.Builder setVrfName(java.lang.String vrfName)

Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type VrfContext.

Parameters:

vrfName - New value for the property.

build

public ALBPool build()