com.vmware.nsx_global_policy.model

Class ALBHealthMonitor.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBHealthMonitor.Builder

Enclosing class:

ALBHealthMonitor

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

Builder class for ALBHealthMonitor.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBHealthMonitor	build()
ALBHealthMonitor.Builder	setAllowDuplicateMonitors(java.lang.Boolean allowDuplicateMonitors) By default, multiple instances of the same healthmonitor to the same server are suppressed intelligently.
ALBHealthMonitor.Builder	setAuthentication(ALBHealthMonitorAuthInfo authentication)
ALBHealthMonitor.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBHealthMonitor.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.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setDescription(java.lang.String description) Description of this resource
ALBHealthMonitor.Builder	setDisableQuickstart(java.lang.Boolean disableQuickstart) During addition of a server or healthmonitors or during bootup, Avi performs sequential health checks rather than waiting for send-interval to kick in, to mark the server up as soon as possible.
ALBHealthMonitor.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBHealthMonitor.Builder	setDnsMonitor(ALBHealthMonitorDNS dnsMonitor)
ALBHealthMonitor.Builder	setExternalMonitor(ALBHealthMonitorExternal externalMonitor)
ALBHealthMonitor.Builder	setFailedChecks(java.lang.Long failedChecks) Number of continuous failed health checks before the server is marked down.
ALBHealthMonitor.Builder	setHttpMonitor(ALBHealthMonitorHttp httpMonitor)
ALBHealthMonitor.Builder	setHttpsMonitor(ALBHealthMonitorHttp httpsMonitor)
ALBHealthMonitor.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBHealthMonitor.Builder	setImapMonitor(ALBHealthMonitorImap imapMonitor)
ALBHealthMonitor.Builder	setImapsMonitor(ALBHealthMonitorImap imapsMonitor)
ALBHealthMonitor.Builder	setIsFederated(java.lang.Boolean isFederated) This field describes the object's replication scope.
ALBHealthMonitor.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.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBHealthMonitor.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBHealthMonitor.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBHealthMonitor.Builder	setMonitorPort(java.lang.Long monitorPort) Use this port instead of the port defined for the server in the Pool.
ALBHealthMonitor.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBHealthMonitor.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBHealthMonitor.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBHealthMonitor.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.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setPop3Monitor(ALBHealthMonitorPop3 pop3Monitor)
ALBHealthMonitor.Builder	setPop3sMonitor(ALBHealthMonitorPop3 pop3sMonitor)
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setRadiusMonitor(ALBHealthMonitorRadius radiusMonitor)
ALBHealthMonitor.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBHealthMonitor.Builder	setReceiveTimeout(java.lang.Long receiveTimeout) A valid response from the server is expected within the receive timeout window.
ALBHealthMonitor.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.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBHealthMonitor.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setSelf(SelfResourceLink self)
ALBHealthMonitor.Builder	setSendInterval(java.lang.Long sendInterval) Frequency, in seconds, that monitors are sent to a server.
ALBHealthMonitor.Builder	setSipMonitor(ALBHealthMonitorSIP sipMonitor)
ALBHealthMonitor.Builder	setSmtpMonitor(ALBHealthMonitorSmtp smtpMonitor)
ALBHealthMonitor.Builder	setSmtpsMonitor(ALBHealthMonitorSmtp smtpsMonitor)
ALBHealthMonitor.Builder	setSuccessfulChecks(java.lang.Long successfulChecks) Number of continuous successful health checks before server is marked up.
ALBHealthMonitor.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.
ALBHealthMonitor.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBHealthMonitor.Builder	setTcpMonitor(ALBHealthMonitorTcp tcpMonitor)
ALBHealthMonitor.Builder	setType(java.lang.String type) Possible values are: ALBHealthMonitor.TYPE_PING ALBHealthMonitor.TYPE_TCP ALBHealthMonitor.TYPE_HTTP ALBHealthMonitor.TYPE_HTTPS ALBHealthMonitor.TYPE_EXTERNAL ALBHealthMonitor.TYPE_UDP ALBHealthMonitor.TYPE_DNS ALBHealthMonitor.TYPE_GSLB ALBHealthMonitor.TYPE_SIP ALBHealthMonitor.TYPE_RADIUS ALBHealthMonitor.TYPE_SMTP ALBHealthMonitor.TYPE_SMTPS ALBHealthMonitor.TYPE_POP3 ALBHealthMonitor.TYPE_POP3S ALBHealthMonitor.TYPE_IMAP ALBHealthMonitor.TYPE_IMAPS Type of the health monitor.
ALBHealthMonitor.Builder	setUdpMonitor(ALBHealthMonitorUdp udpMonitor)
ALBHealthMonitor.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites 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 ALBHealthMonitor.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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 ALBHealthMonitor.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.

setAllowDuplicateMonitors

public ALBHealthMonitor.Builder setAllowDuplicateMonitors(java.lang.Boolean allowDuplicateMonitors)

By default, multiple instances of the same healthmonitor to the same server are suppressed intelligently. In rare cases, the monitor may have specific constructs that go beyond the server keys (ip, port, etc.) during which such suppression is not desired. Use this knob to allow duplicates. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition.

Parameters:

allowDuplicateMonitors - New value for the property.

setAuthentication

public ALBHealthMonitor.Builder setAuthentication(ALBHealthMonitorAuthInfo authentication)

Parameters:

authentication - New value for the property.

setDisableQuickstart

public ALBHealthMonitor.Builder setDisableQuickstart(java.lang.Boolean disableQuickstart)

During addition of a server or healthmonitors or during bootup, Avi performs sequential health checks rather than waiting for send-interval to kick in, to mark the server up as soon as possible. This knob may be used to turn this feature off. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.

Parameters:

disableQuickstart - New value for the property.

setDnsMonitor

public ALBHealthMonitor.Builder setDnsMonitor(ALBHealthMonitorDNS dnsMonitor)

Parameters:

dnsMonitor - New value for the property.

setExternalMonitor

public ALBHealthMonitor.Builder setExternalMonitor(ALBHealthMonitorExternal externalMonitor)

Parameters:

externalMonitor - New value for the property.

setFailedChecks

public ALBHealthMonitor.Builder setFailedChecks(java.lang.Long failedChecks)

Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. Default value when not specified in API or module is interpreted by ALB Controller as 2. format: int64

Parameters:

failedChecks - New value for the property.

setHttpMonitor

public ALBHealthMonitor.Builder setHttpMonitor(ALBHealthMonitorHttp httpMonitor)

Parameters:

httpMonitor - New value for the property.

setHttpsMonitor

public ALBHealthMonitor.Builder setHttpsMonitor(ALBHealthMonitorHttp httpsMonitor)

Parameters:

httpsMonitor - New value for the property.

setImapMonitor

public ALBHealthMonitor.Builder setImapMonitor(ALBHealthMonitorImap imapMonitor)

Parameters:

imapMonitor - New value for the property.

setImapsMonitor

public ALBHealthMonitor.Builder setImapsMonitor(ALBHealthMonitorImap imapsMonitor)

Parameters:

imapsMonitor - New value for the property.

setIsFederated

public ALBHealthMonitor.Builder setIsFederated(java.lang.Boolean isFederated)

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. 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:

isFederated - New value for the property.

setMarkers

public ALBHealthMonitor.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.

setMonitorPort

public ALBHealthMonitor.Builder setMonitorPort(java.lang.Long monitorPort)

Use this port instead of the port defined for the server in the Pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the Pool. Allowed values are 1-65535. Special values are 0 - 'Use server port'. format: int64

Parameters:

monitorPort - New value for the property.

setPop3Monitor

public ALBHealthMonitor.Builder setPop3Monitor(ALBHealthMonitorPop3 pop3Monitor)

Parameters:

pop3Monitor - New value for the property.

setPop3sMonitor

public ALBHealthMonitor.Builder setPop3sMonitor(ALBHealthMonitorPop3 pop3sMonitor)

Parameters:

pop3sMonitor - New value for the property.

setRadiusMonitor

public ALBHealthMonitor.Builder setRadiusMonitor(ALBHealthMonitorRadius radiusMonitor)

Parameters:

radiusMonitor - New value for the property.

setReceiveTimeout

public ALBHealthMonitor.Builder setReceiveTimeout(java.lang.Long receiveTimeout)

A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value. Allowed values are 1-2400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 4. format: int64

Parameters:

receiveTimeout - New value for the property.

setSendInterval

public ALBHealthMonitor.Builder setSendInterval(java.lang.Long sendInterval)

Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10. format: int64

Parameters:

sendInterval - New value for the property.

setSipMonitor

public ALBHealthMonitor.Builder setSipMonitor(ALBHealthMonitorSIP sipMonitor)

Parameters:

sipMonitor - New value for the property.

setSmtpMonitor

public ALBHealthMonitor.Builder setSmtpMonitor(ALBHealthMonitorSmtp smtpMonitor)

Parameters:

smtpMonitor - New value for the property.

setSmtpsMonitor

public ALBHealthMonitor.Builder setSmtpsMonitor(ALBHealthMonitorSmtp smtpsMonitor)

Parameters:

smtpsMonitor - New value for the property.

setSuccessfulChecks

public ALBHealthMonitor.Builder setSuccessfulChecks(java.lang.Long successfulChecks)

Number of continuous successful health checks before server is marked up. Allowed values are 1-50. Default value when not specified in API or module is interpreted by ALB Controller as 2. format: int64

Parameters:

successfulChecks - New value for the property.

setTcpMonitor

public ALBHealthMonitor.Builder setTcpMonitor(ALBHealthMonitorTcp tcpMonitor)

Parameters:

tcpMonitor - New value for the property.

setType

public ALBHealthMonitor.Builder setType(java.lang.String type)

Possible values are:

• ALBHealthMonitor.TYPE_PING
• ALBHealthMonitor.TYPE_TCP
• ALBHealthMonitor.TYPE_HTTP
• ALBHealthMonitor.TYPE_HTTPS
• ALBHealthMonitor.TYPE_EXTERNAL
• ALBHealthMonitor.TYPE_UDP
• ALBHealthMonitor.TYPE_DNS
• ALBHealthMonitor.TYPE_GSLB
• ALBHealthMonitor.TYPE_SIP
• ALBHealthMonitor.TYPE_RADIUS
• ALBHealthMonitor.TYPE_SMTP
• ALBHealthMonitor.TYPE_SMTPS
• ALBHealthMonitor.TYPE_POP3
• ALBHealthMonitor.TYPE_POP3S
• ALBHealthMonitor.TYPE_IMAP
• ALBHealthMonitor.TYPE_IMAPS

Type of the health monitor. Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS, HEALTH_MONITOR_SMTP, HEALTH_MONITOR_SMTPS, HEALTH_MONITOR_POP3, HEALTH_MONITOR_POP3S, HEALTH_MONITOR_IMAP, HEALTH_MONITOR_IMAPS. Allowed in Basic(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP,HEALTH_MONITOR_HTTP,HEALTH_MONITOR_HTTPS) edition, Essentials(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP) edition, Enterprise edition.

Parameters:

type - New value for the property.

setUdpMonitor

public ALBHealthMonitor.Builder setUdpMonitor(ALBHealthMonitorUdp udpMonitor)

Parameters:

udpMonitor - New value for the property.

build

public ALBHealthMonitor build()