com.vmware.nsx_global_policy.model

Class LBHttpMonitorProfile.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.LBHttpMonitorProfile.Builder

Enclosing class:

LBHttpMonitorProfile

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

Builder class for LBHttpMonitorProfile.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String resourceType) Constructor with parameters for the required properties of LBHttpMonitorProfile.

Method Summary

Modifier and Type	Method and Description
LBHttpMonitorProfile	build()
LBHttpMonitorProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setDescription(java.lang.String description) Description of this resource
LBHttpMonitorProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LBHttpMonitorProfile.Builder	setFallCount(java.lang.Long fallCount) Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.
LBHttpMonitorProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
LBHttpMonitorProfile.Builder	setInterval(java.lang.Long interval) Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LBHttpMonitorProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LBHttpMonitorProfile.Builder	setMonitorPort(java.lang.Long monitorPort) Typically, monitors perform healthchecks to Group members using the member IP address and pool_port.
LBHttpMonitorProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LBHttpMonitorProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LBHttpMonitorProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setRequestBody(java.lang.String requestBody) String to send as part of HTTP health check request body.
LBHttpMonitorProfile.Builder	setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders) Array of HTTP request headers.
LBHttpMonitorProfile.Builder	setRequestMethod(java.lang.String requestMethod) Possible values are: LBHttpMonitorProfile.REQUEST_METHOD_GET LBHttpMonitorProfile.REQUEST_METHOD_OPTIONS LBHttpMonitorProfile.REQUEST_METHOD_POST LBHttpMonitorProfile.REQUEST_METHOD_HEAD LBHttpMonitorProfile.REQUEST_METHOD_PUT The health check method for HTTP monitor type.
LBHttpMonitorProfile.Builder	setRequestUrl(java.lang.String requestUrl) For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
LBHttpMonitorProfile.Builder	setRequestVersion(java.lang.String requestVersion) Possible values are: LBHttpMonitorProfile.REQUEST_VERSION_0 LBHttpMonitorProfile.REQUEST_VERSION_1 HTTP request version.
LBHttpMonitorProfile.Builder	setResponseBody(java.lang.String responseBody) If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match.
LBHttpMonitorProfile.Builder	setResponseStatusCodes(java.util.List<java.lang.Long> responseStatusCodes) The HTTP response status code should be a valid HTTP status code.
LBHttpMonitorProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LBHttpMonitorProfile.Builder	setRiseCount(java.lang.Long riseCount) Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setSelf(SelfResourceLink self)
LBHttpMonitorProfile.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.
LBHttpMonitorProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LBHttpMonitorProfile.Builder	setTimeout(java.lang.Long timeout) Timeout specified in seconds.
LBHttpMonitorProfile.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(java.lang.String resourceType)

Constructor with parameters for the required properties of LBHttpMonitorProfile.

Method Detail

setRequestBody

public LBHttpMonitorProfile.Builder setRequestBody(java.lang.String requestBody)

String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.

Parameters:

requestBody - New value for the property.

setRequestHeaders

public LBHttpMonitorProfile.Builder setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders)

Array of HTTP request headers.

Parameters:

requestHeaders - New value for the property.

setRequestMethod

public LBHttpMonitorProfile.Builder setRequestMethod(java.lang.String requestMethod)

Possible values are:

• LBHttpMonitorProfile.REQUEST_METHOD_GET
• LBHttpMonitorProfile.REQUEST_METHOD_OPTIONS
• LBHttpMonitorProfile.REQUEST_METHOD_POST
• LBHttpMonitorProfile.REQUEST_METHOD_HEAD
• LBHttpMonitorProfile.REQUEST_METHOD_PUT

The health check method for HTTP monitor type.

Parameters:

requestMethod - New value for the property.

setRequestUrl

public LBHttpMonitorProfile.Builder setRequestUrl(java.lang.String requestUrl)

For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.

Parameters:

requestUrl - New value for the property.

setRequestVersion

public LBHttpMonitorProfile.Builder setRequestVersion(java.lang.String requestVersion)

Possible values are:

• LBHttpMonitorProfile.REQUEST_VERSION_0
• LBHttpMonitorProfile.REQUEST_VERSION_1

HTTP request version.

Parameters:

requestVersion - New value for the property.

setResponseBody

public LBHttpMonitorProfile.Builder setResponseBody(java.lang.String responseBody)

If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.

Parameters:

responseBody - New value for the property.

setResponseStatusCodes

public LBHttpMonitorProfile.Builder setResponseStatusCodes(java.util.List<java.lang.Long> responseStatusCodes)

The HTTP response status code should be a valid HTTP status code. format: int32

Parameters:

responseStatusCodes - New value for the property.

setFallCount

public LBHttpMonitorProfile.Builder setFallCount(java.lang.Long fallCount)

Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64

Parameters:

fallCount - New value for the property.

setInterval

public LBHttpMonitorProfile.Builder setInterval(java.lang.Long interval)

Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64

Parameters:

interval - New value for the property.

setMonitorPort

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

Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32

Parameters:

monitorPort - New value for the property.

setRiseCount

public LBHttpMonitorProfile.Builder setRiseCount(java.lang.Long riseCount)

Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64

Parameters:

riseCount - New value for the property.

setTimeout

public LBHttpMonitorProfile.Builder setTimeout(java.lang.Long timeout)

Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

Parameters:

timeout - New value for the property.

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

build

public LBHttpMonitorProfile build()