vertx-lang-scala-docs_2.12 3.6.2 API - io.vertx.scala.ext.consul.ConsulClientOptions

Set the ACL token. When provided, the client will use this token when making requests to the Consul by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' ACL policy, is used.

def setAlpnVersions(value: Buffer[HttpVersion]): ConsulClientOptions

Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.

Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to ConsulClientOptions:

: [ "h2", "http/1.1" ]
otherwise: [HttpClientOptions]

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setConnectTimeout(value: Int): ConsulClientOptions

Set the connect timeout

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase

def setDc(value: String): ConsulClientOptions

Set the datacenter name.

Set the datacenter name. When provided, the client will use it when making requests to the Consul by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

def setDecoderInitialBufferSize(value: Int): ConsulClientOptions

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setDefaultHost(value: String): ConsulClientOptions

Set the default host name to be used by this client in requests if none is provided when making the request.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setDefaultPort(value: Int): ConsulClientOptions

Set the default port to be used by this client in requests if none is provided when making the request.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setEnabledSecureTransportProtocols(value: Set[String]): ConsulClientOptions

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setFollowRedirects(value: Boolean): ConsulClientOptions

Configure the default behavior of the client to follow HTTP 30x redirections.

Definition Classes: ConsulClientOptions → WebClientOptions

def setForceSni(value: Boolean): ConsulClientOptions

By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to true forces the server name to be always sent.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setHttp2ClearTextUpgrade(value: Boolean): ConsulClientOptions

Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setHttp2ConnectionWindowSize(value: Int): ConsulClientOptions

Set the default HTTP/2 connection window size.

Set the default HTTP/2 connection window size. It overrides the initial window size set by , so the connection window size is greater than for its streams, in order the data throughput.

A value of -1 reuses the initial window size setting.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setHttp2KeepAliveTimeout(value: Int): ConsulClientOptions

Set the keep alive timeout for HTTP/2 connections, in seconds.

This value determines how long a connection remains unused in the pool before being evicted and closed.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setHttp2MaxPoolSize(value: Int): ConsulClientOptions

Set the maximum pool size for HTTP/2 connections

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setHttp2MultiplexingLimit(value: Int): ConsulClientOptions

Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection.

Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setIdleTimeout(value: Int): ConsulClientOptions

Set the idle timeout, in seconds.

Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setIdleTimeoutUnit(value: TimeUnit): ConsulClientOptions

Set the idle timeout unit.

Set the idle timeout unit. If not specified, default is seconds.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setInitialSettings(value: Http2Settings): ConsulClientOptions

Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setJdkSslEngineOptions(value: JdkSSLEngineOptions): ConsulClientOptions

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setKeepAlive(value: Boolean): ConsulClientOptions

Set whether keep alive is enabled on the client

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setKeepAliveTimeout(value: Int): ConsulClientOptions

Set the keep alive timeout for HTTP/1.x, in seconds.

This value determines how long a connection remains unused in the pool before being evicted and closed.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setKeyStoreOptions(value: JksOptions): ConsulClientOptions

Set the key/cert options in jks format, aka Java keystore.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setLocalAddress(value: String): ConsulClientOptions

Set the local interface to bind for network connections.

Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase

def setLogActivity(value: Boolean): ConsulClientOptions

Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setMaxChunkSize(value: Int): ConsulClientOptions

Set the maximum HTTP chunk size

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxHeaderSize(value: Int): ConsulClientOptions

Set the maximum length of all headers for HTTP/1.x .

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxInitialLineLength(value: Int): ConsulClientOptions

Set the maximum length of the initial line for HTTP/1.x (e.g.

Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxPoolSize(value: Int): ConsulClientOptions

Set the maximum pool size for connections

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxRedirects(value: Int): ConsulClientOptions

Set to maxRedirects the maximum number of redirection a request can follow.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxWaitQueueSize(value: Int): ConsulClientOptions

Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException.

Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxWebsocketFrameSize(value: Int): ConsulClientOptions

Set the max websocket frame size

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMaxWebsocketMessageSize(value: Int): ConsulClientOptions

Set the max websocket message size

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setMetricsName(value: String): ConsulClientOptions

Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase

def setOpenSslEngineOptions(value: OpenSSLEngineOptions): ConsulClientOptions

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemKeyCertOptions(value: PemKeyCertOptions): ConsulClientOptions

Set the key/cert store options in pem format.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemTrustOptions(value: PemTrustOptions): ConsulClientOptions

Set the trust options.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxKeyCertOptions(value: PfxOptions): ConsulClientOptions

Set the key/cert options in pfx format.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxTrustOptions(value: PfxOptions): ConsulClientOptions

Set the trust options in pfx format

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPipelining(value: Boolean): ConsulClientOptions

Set whether pipe-lining is enabled on the client

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setPipeliningLimit(value: Int): ConsulClientOptions

Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setPoolCleanerPeriod(value: Int): ConsulClientOptions

Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setProtocolVersion(value: HttpVersion): ConsulClientOptions

Set the protocol version.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setProxyOptions(value: ProxyOptions): ConsulClientOptions

Set proxy options for connections via CONNECT proxy (e.g.

Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase

def setReceiveBufferSize(value: Int): ConsulClientOptions

Set the TCP receive buffer size

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReuseAddress(value: Boolean): ConsulClientOptions

Set the value of reuse address

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReusePort(value: Boolean): ConsulClientOptions

Set the value of reuse port.

This is only supported by native transports.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setSendBufferSize(value: Int): ConsulClientOptions

Set the TCP send buffer size

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setSendUnmaskedFrames(value: Boolean): ConsulClientOptions

Set true when the client wants to skip frame masking.

Set true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions

def setSoLinger(value: Int): ConsulClientOptions

Set whether SO_linger keep alive is enabled

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setSsl(value: Boolean): ConsulClientOptions

Set whether SSL/TLS is enabled

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTcpCork(value: Boolean): ConsulClientOptions

Enable the TCP_CORK option - only with linux native transport.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTcpFastOpen(value: Boolean): ConsulClientOptions

Enable the TCP_FASTOPEN option - only with linux native transport.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTcpKeepAlive(value: Boolean): ConsulClientOptions

Set whether TCP keep alive is enabled

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTcpNoDelay(value: Boolean): ConsulClientOptions

Set whether TCP no delay is enabled

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTcpQuickAck(value: Boolean): ConsulClientOptions

Enable the TCP_QUICKACK option - only with linux native transport.

Definition Classes: ConsulClientOptions → WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setTimeout(value: Long): ConsulClientOptions

Sets the amount of time (in milliseconds) after which if the request does not return any data within the timeout period an failure will be passed to the handler and the request will be closed.