LbHttpsMonitor.Builder (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.LbHttpsMonitor.Builder

Enclosing class:: LbHttpsMonitor

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

Builder class for LbHttpsMonitor.

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LbHttpsMonitor`	`build()`
`LbHttpsMonitor.Builder`	`setCertificateChainDepth(java.lang.Long certificateChainDepth)` authentication depth is used to set the verification depth in the server certificates chain.
`LbHttpsMonitor.Builder`	`setCipherGroupLabel(java.lang.String cipherGroupLabel)` Possible values are: `LbHttpsMonitor.CIPHER_GROUP_LABEL_BALANCED` `LbHttpsMonitor.CIPHER_GROUP_LABEL_HIGH_SECURITY` `LbHttpsMonitor.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY` `LbHttpsMonitor.CIPHER_GROUP_LABEL_CUSTOM` It is a label of cipher group which is mostly consumed by GUI.
`LbHttpsMonitor.Builder`	`setCiphers(java.util.List<java.lang.String> ciphers)` Possible values are: `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_CBC_SHA` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_CBC_SHA` `LbHttpsMonitor.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` `LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_CBC_SHA256` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_GCM_SHA256` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_CBC_SHA256` `LbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_GCM_SHA384` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384` `LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384` `LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384` `LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384` supported SSL cipher list to servers
`LbHttpsMonitor.Builder`	`setClientCertificateId(java.lang.String clientCertificateId)` client certificate can be specified to support client authentication.
`LbHttpsMonitor.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.
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setDescription(java.lang.String description)` Description of this resource
`LbHttpsMonitor.Builder`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`LbHttpsMonitor.Builder`	`setFallCount(java.lang.Long fallCount)` num of consecutive checks must fail before marking it down format: int64
`LbHttpsMonitor.Builder`	`setId(java.lang.String id)` Unique identifier of this resource
`LbHttpsMonitor.Builder`	`setInterval(java.lang.Long interval)` the frequency at which the system issues the monitor check (in second) format: int64
`LbHttpsMonitor.Builder`	`setIsFips(java.lang.Boolean isFips)` This flag is set to true when all the ciphers and protocols are FIPS compliant.
`LbHttpsMonitor.Builder`	`setIsSecure(java.lang.Boolean isSecure)` This flag is set to true when all the ciphers and protocols are secure.
`LbHttpsMonitor.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.
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`LbHttpsMonitor.Builder`	`setMonitorPort(java.lang.String monitorPort)` If the monitor port is specified, it would override pool member port setting for healthcheck.
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setProtocols(java.util.List<java.lang.String> protocols)` Possible values are: `LbHttpsMonitor.PROTOCOLS_SSL_V2` `LbHttpsMonitor.PROTOCOLS_SSL_V3` `LbHttpsMonitor.PROTOCOLS_TLS_V1` `LbHttpsMonitor.PROTOCOLS_TLS_V1_1` `LbHttpsMonitor.PROTOCOLS_TLS_V1_2` SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.
`LbHttpsMonitor.Builder`	`setRequestBody(java.lang.String requestBody)` String to send as part of HTTP health check request body.
`LbHttpsMonitor.Builder`	`setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders)` Array of HTTP request headers
`LbHttpsMonitor.Builder`	`setRequestMethod(java.lang.String requestMethod)` Possible values are: `LbHttpsMonitor.REQUEST_METHOD_GET` `LbHttpsMonitor.REQUEST_METHOD_OPTIONS` `LbHttpsMonitor.REQUEST_METHOD_POST` `LbHttpsMonitor.REQUEST_METHOD_HEAD` `LbHttpsMonitor.REQUEST_METHOD_PUT` the health check method for HTTP monitor type
`LbHttpsMonitor.Builder`	`setRequestUrl(java.lang.String requestUrl)` URL used for HTTP monitor
`LbHttpsMonitor.Builder`	`setRequestVersion(java.lang.String requestVersion)` Possible values are: `LbHttpsMonitor.REQUEST_VERSION_0` `LbHttpsMonitor.REQUEST_VERSION_1` HTTP request version
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setResponseStatusCodes(java.util.List<java.lang.Long> responseStatusCodes)` The HTTP response status code should be a valid HTTP status code.
`LbHttpsMonitor.Builder`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`LbHttpsMonitor.Builder`	`setRiseCount(java.lang.Long riseCount)` num of consecutive checks must pass before marking it up format: int64
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setSelf(SelfResourceLink self)`
`LbHttpsMonitor.Builder`	`setServerAuth(java.lang.String serverAuth)` Possible values are: `LbHttpsMonitor.SERVER_AUTH_REQUIRED` `LbHttpsMonitor.SERVER_AUTH_IGNORE` server authentication mode
`LbHttpsMonitor.Builder`	`setServerAuthCaIds(java.util.List<java.lang.String> serverAuthCaIds)` If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
`LbHttpsMonitor.Builder`	`setServerAuthCrlIds(java.util.List<java.lang.String> serverAuthCrlIds)` A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
`LbHttpsMonitor.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.
`LbHttpsMonitor.Builder`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`LbHttpsMonitor.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 LbHttpsMonitor.
- Method Detail
  - setCertificateChainDepth
```
public LbHttpsMonitor.Builder setCertificateChainDepth(java.lang.Long certificateChainDepth)
```
    authentication depth is used to set the verification depth in the server certificates chain. format: int64
    
    Parameters:
    
    certificateChainDepth - New value for the property.
  - setCipherGroupLabel
```
public LbHttpsMonitor.Builder setCipherGroupLabel(java.lang.String cipherGroupLabel)
```
    Possible values are:
    It is a label of cipher group which is mostly consumed by GUI.
    Parameters:
    
    cipherGroupLabel - New value for the property.
  - setCiphers
```
public LbHttpsMonitor.Builder setCiphers(java.util.List<java.lang.String> ciphers)
```
    Possible values are:
    supported SSL cipher list to servers
    Parameters:
    
    ciphers - New value for the property.
  - setClientCertificateId
```
public LbHttpsMonitor.Builder setClientCertificateId(java.lang.String clientCertificateId)
```
    client certificate can be specified to support client authentication.
    
    Parameters:
    
    clientCertificateId - New value for the property.
  - setIsFips
```
public LbHttpsMonitor.Builder setIsFips(java.lang.Boolean isFips)
```
    This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.. 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:
    
    isFips - New value for the property.
  - setIsSecure
```
public LbHttpsMonitor.Builder setIsSecure(java.lang.Boolean isSecure)
```
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. 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:
    
    isSecure - New value for the property.
  - setProtocols
```
public LbHttpsMonitor.Builder setProtocols(java.util.List<java.lang.String> protocols)
```
    Possible values are:
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    Parameters:
    
    protocols - New value for the property.
  - setRequestBody
```
public LbHttpsMonitor.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 LbHttpsMonitor.Builder setRequestHeaders(java.util.List<LbHttpRequestHeader> requestHeaders)
```
    Array of HTTP request headers
    
    Parameters:
    
    requestHeaders - New value for the property.
  - setRequestMethod
```
public LbHttpsMonitor.Builder setRequestMethod(java.lang.String requestMethod)
```
    Possible values are:
    the health check method for HTTP monitor type
    Parameters:
    
    requestMethod - New value for the property.
  - setRequestUrl
```
public LbHttpsMonitor.Builder setRequestUrl(java.lang.String requestUrl)
```
    URL used for HTTP monitor
    
    Parameters:
    
    requestUrl - New value for the property.
  - setRequestVersion
```
public LbHttpsMonitor.Builder setRequestVersion(java.lang.String requestVersion)
```
    Possible values are:
    - LbHttpsMonitor.REQUEST_VERSION_0
    - LbHttpsMonitor.REQUEST_VERSION_1
    HTTP request version
    Parameters:
    
    requestVersion - New value for the property.
  - setResponseBody
```
public LbHttpsMonitor.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 LbHttpsMonitor.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.
  - setServerAuth
```
public LbHttpsMonitor.Builder setServerAuth(java.lang.String serverAuth)
```
    Possible values are:
    - LbHttpsMonitor.SERVER_AUTH_REQUIRED
    - LbHttpsMonitor.SERVER_AUTH_IGNORE
    server authentication mode
    Parameters:
    
    serverAuth - New value for the property.
  - setServerAuthCaIds
```
public LbHttpsMonitor.Builder setServerAuthCaIds(java.util.List<java.lang.String> serverAuthCaIds)
```
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    
    Parameters:
    
    serverAuthCaIds - New value for the property.
  - setServerAuthCrlIds
```
public LbHttpsMonitor.Builder setServerAuthCrlIds(java.util.List<java.lang.String> serverAuthCrlIds)
```
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    
    Parameters:
    
    serverAuthCrlIds - New value for the property.
  - setFallCount
```
public LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.Builder setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - setRevision
```
public LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.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 LbHttpsMonitor.Builder setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - setDisplayName
```
public LbHttpsMonitor.Builder setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - setId
```
public LbHttpsMonitor.Builder setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - setTags
```
public LbHttpsMonitor.Builder setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - build
```
public LbHttpsMonitor build()
```

Class LbHttpsMonitor.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setCertificateChainDepth

setCipherGroupLabel

setCiphers

setClientCertificateId

setIsFips

setIsSecure

setProtocols

setRequestBody

setRequestHeaders

setRequestMethod

setRequestUrl

setRequestVersion

setResponseBody

setResponseStatusCodes

setServerAuth

setServerAuthCaIds

setServerAuthCrlIds

setFallCount

setInterval

setMonitorPort

setRiseCount

setTimeout

setLinks

setSchema

setSelf

setRevision

setCreateTime

setCreateUser

setLastModifiedTime

setLastModifiedUser

setProtection

setSystemOwned

setDescription

setDisplayName

setId

setTags

build