com.vmware.nsx.model

Class HttpServiceProperties.Builder

java.lang.Object

com.vmware.nsx.model.HttpServiceProperties.Builder

Enclosing class:

HttpServiceProperties

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

Builder class for HttpServiceProperties.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpServiceProperties	build()
HttpServiceProperties.Builder	setBasicAuthenticationEnabled(java.lang.Boolean basicAuthenticationEnabled) Identifies whether basic authentication is enabled or disabled in API calls.
HttpServiceProperties.Builder	setCertificate(Certificate certificate)
HttpServiceProperties.Builder	setCipherSuites(java.util.List<CipherSuite> cipherSuites) Cipher suites used to secure contents of connection
HttpServiceProperties.Builder	setClientApiConcurrencyLimit(java.lang.Long clientApiConcurrencyLimit) The maximum number of concurrent API requests that will be serviced for a given authenticated client.
HttpServiceProperties.Builder	setClientApiRateLimit(java.lang.Long clientApiRateLimit) The maximum number of API requests that will be serviced per second for a given authenticated client.
HttpServiceProperties.Builder	setConnectionTimeout(java.lang.Long connectionTimeout) NSX connection timeout, set to 0 to configure no timeout format: int64
HttpServiceProperties.Builder	setCookieBasedAuthenticationEnabled(java.lang.Boolean cookieBasedAuthenticationEnabled) Identifies whether cookie-based authentication is enabled or disabled in API calls.
HttpServiceProperties.Builder	setGlobalApiConcurrencyLimit(java.lang.Long globalApiConcurrencyLimit) The maximum number of concurrent API requests that will be serviced.
HttpServiceProperties.Builder	setLoggingLevel(java.lang.String loggingLevel) Possible values are: HttpServiceProperties.LOGGING_LEVEL_OFF HttpServiceProperties.LOGGING_LEVEL_FATAL HttpServiceProperties.LOGGING_LEVEL_ERROR HttpServiceProperties.LOGGING_LEVEL_WARN HttpServiceProperties.LOGGING_LEVEL_INFO HttpServiceProperties.LOGGING_LEVEL_DEBUG HttpServiceProperties.LOGGING_LEVEL_TRACE Service logging level
HttpServiceProperties.Builder	setProtocolVersions(java.util.List<ProtocolVersion> protocolVersions) TLS protocol versions
HttpServiceProperties.Builder	setRedirectHost(java.lang.String redirectHost) Host name or IP address to use for redirect location headers, or empty string to derive from current request
HttpServiceProperties.Builder	setSessionTimeout(java.lang.Long sessionTimeout) NSX session inactivity timeout, set to 0 to configure no timeout 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()

Constructor with parameters for the required properties of HttpServiceProperties.

Method Detail

setBasicAuthenticationEnabled

public HttpServiceProperties.Builder setBasicAuthenticationEnabled(java.lang.Boolean basicAuthenticationEnabled)

Identifies whether basic authentication is enabled or disabled in API calls.

Parameters:

basicAuthenticationEnabled - New value for the property.

setCertificate

public HttpServiceProperties.Builder setCertificate(Certificate certificate)

Parameters:

certificate - New value for the property.

setCipherSuites

public HttpServiceProperties.Builder setCipherSuites(java.util.List<CipherSuite> cipherSuites)

Cipher suites used to secure contents of connection

Parameters:

cipherSuites - New value for the property.

setClientApiConcurrencyLimit

public HttpServiceProperties.Builder setClientApiConcurrencyLimit(java.lang.Long clientApiConcurrencyLimit)

The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. format: int64

Parameters:

clientApiConcurrencyLimit - New value for the property.

setClientApiRateLimit

public HttpServiceProperties.Builder setClientApiRateLimit(java.lang.Long clientApiRateLimit)

The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0. format: int64

Parameters:

clientApiRateLimit - New value for the property.

setConnectionTimeout

public HttpServiceProperties.Builder setConnectionTimeout(java.lang.Long connectionTimeout)

NSX connection timeout, set to 0 to configure no timeout format: int64

Parameters:

connectionTimeout - New value for the property.

setCookieBasedAuthenticationEnabled

public HttpServiceProperties.Builder setCookieBasedAuthenticationEnabled(java.lang.Boolean cookieBasedAuthenticationEnabled)

Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.

Parameters:

cookieBasedAuthenticationEnabled - New value for the property.

setGlobalApiConcurrencyLimit

public HttpServiceProperties.Builder setGlobalApiConcurrencyLimit(java.lang.Long globalApiConcurrencyLimit)

The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. format: int64

Parameters:

globalApiConcurrencyLimit - New value for the property.

setLoggingLevel

public HttpServiceProperties.Builder setLoggingLevel(java.lang.String loggingLevel)

Possible values are:

• HttpServiceProperties.LOGGING_LEVEL_OFF
• HttpServiceProperties.LOGGING_LEVEL_FATAL
• HttpServiceProperties.LOGGING_LEVEL_ERROR
• HttpServiceProperties.LOGGING_LEVEL_WARN
• HttpServiceProperties.LOGGING_LEVEL_INFO
• HttpServiceProperties.LOGGING_LEVEL_DEBUG
• HttpServiceProperties.LOGGING_LEVEL_TRACE

Service logging level

Parameters:

loggingLevel - New value for the property.

setProtocolVersions

public HttpServiceProperties.Builder setProtocolVersions(java.util.List<ProtocolVersion> protocolVersions)

TLS protocol versions

Parameters:

protocolVersions - New value for the property.

setRedirectHost

public HttpServiceProperties.Builder setRedirectHost(java.lang.String redirectHost)

Host name or IP address to use for redirect location headers, or empty string to derive from current request

Parameters:

redirectHost - New value for the property.

setSessionTimeout

public HttpServiceProperties.Builder setSessionTimeout(java.lang.Long sessionTimeout)

NSX session inactivity timeout, set to 0 to configure no timeout format: int64

Parameters:

sessionTimeout - New value for the property.

build

public HttpServiceProperties build()