com.vmware.nsx.model

Class LbHttpMonitor.Builder

java.lang.Object

com.vmware.nsx.model.LbHttpMonitor.Builder

Enclosing class:

LbHttpMonitor

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

Builder class for LbHttpMonitor.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LbHttpMonitor	build()
LbHttpMonitor.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.
LbHttpMonitor.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.
LbHttpMonitor.Builder	setDescription(java.lang.String description) Description of this resource
LbHttpMonitor.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LbHttpMonitor.Builder	setFallCount(java.lang.Long fallCount) num of consecutive checks must fail before marking it down format: int64
LbHttpMonitor.Builder	setId(java.lang.String id) Unique identifier of this resource
LbHttpMonitor.Builder	setInterval(java.lang.Long interval) the frequency at which the system issues the monitor check (in second) format: int64
LbHttpMonitor.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.
LbHttpMonitor.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.
LbHttpMonitor.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LbHttpMonitor.Builder	setMonitorPort(java.lang.String monitorPort) If the monitor port is specified, it would override pool member port setting for healthcheck.
LbHttpMonitor.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.
LbHttpMonitor.Builder	setRequestBody(java.lang.String requestBody) String to send as part of HTTP health check request body.
LbHttpMonitor.Builder	setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders) Array of HTTP request headers
LbHttpMonitor.Builder	setRequestMethod(java.lang.String requestMethod) Possible values are: LbHttpMonitor.REQUEST_METHOD_GET LbHttpMonitor.REQUEST_METHOD_OPTIONS LbHttpMonitor.REQUEST_METHOD_POST LbHttpMonitor.REQUEST_METHOD_HEAD LbHttpMonitor.REQUEST_METHOD_PUT the health check method for HTTP monitor type
LbHttpMonitor.Builder	setRequestUrl(java.lang.String requestUrl) URL used for HTTP monitor
LbHttpMonitor.Builder	setRequestVersion(java.lang.String requestVersion) Possible values are: LbHttpMonitor.REQUEST_VERSION_0 LbHttpMonitor.REQUEST_VERSION_1 HTTP request version
LbHttpMonitor.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.
LbHttpMonitor.Builder	setResponseStatusCodes(java.util.List<java.lang.Long> responseStatusCodes) The HTTP response status code should be a valid HTTP status code.
LbHttpMonitor.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LbHttpMonitor.Builder	setRiseCount(java.lang.Long riseCount) num of consecutive checks must pass before marking it up format: int64
LbHttpMonitor.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.
LbHttpMonitor.Builder	setSelf(SelfResourceLink self)
LbHttpMonitor.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.
LbHttpMonitor.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LbHttpMonitor.Builder	setTimeout(java.lang.Long timeout) the number of seconds the target has in which to respond to the monitor request format: int64

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

Method Detail

setRequestBody

public LbHttpMonitor.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 LbHttpMonitor.Builder setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders)

Array of HTTP request headers

Parameters:

requestHeaders - New value for the property.

setRequestMethod

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

Possible values are:

• LbHttpMonitor.REQUEST_METHOD_GET
• LbHttpMonitor.REQUEST_METHOD_OPTIONS
• LbHttpMonitor.REQUEST_METHOD_POST
• LbHttpMonitor.REQUEST_METHOD_HEAD
• LbHttpMonitor.REQUEST_METHOD_PUT

the health check method for HTTP monitor type

Parameters:

requestMethod - New value for the property.

setRequestUrl

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

URL used for HTTP monitor

Parameters:

requestUrl - New value for the property.

setRequestVersion

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

Possible values are:

• LbHttpMonitor.REQUEST_VERSION_0
• LbHttpMonitor.REQUEST_VERSION_1

HTTP request version

Parameters:

requestVersion - New value for the property.

setResponseBody

public LbHttpMonitor.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 LbHttpMonitor.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 LbHttpMonitor.Builder setFallCount(java.lang.Long fallCount)

num of consecutive checks must fail before marking it down format: int64

Parameters:

fallCount - New value for the property.

setInterval

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

the frequency at which the system issues the monitor check (in second) format: int64

Parameters:

interval - New value for the property.

setMonitorPort

public LbHttpMonitor.Builder setMonitorPort(java.lang.String monitorPort)

If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. For ICMP monitor, monitor_port is not required. format: port-or-range

Parameters:

monitorPort - New value for the property.

setRiseCount

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

num of consecutive checks must pass before marking it up format: int64

Parameters:

riseCount - New value for the property.

setTimeout

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

the number of seconds the target has in which to respond to the monitor request format: int64

Parameters:

timeout - New value for the property.

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

build

public LbHttpMonitor build()