## Uses of Class
io.vertx.ext.consul.ConsulClientOptions

- Packages that use ConsulClientOptions
  Package | Description
  --- | ---
  io.vertx.ext.consul |
  io.vertx.reactivex.ext.consul |
  io.vertx.rxjava.ext.consul |

- - ### Uses of ConsulClientOptions in io.vertx.ext.consul

    Methods in io.vertx.ext.consul that return ConsulClientOptions
    Modifier and Type | Method and Description
    --- | ---
    `ConsulClientOptions` | ConsulClientOptions.`addCrlPath(String crlPath)` Add a CRL path
    `ConsulClientOptions` | ConsulClientOptions.`addCrlValue(Buffer crlValue)` Add a CRL value
    `ConsulClientOptions` | ConsulClientOptions.`addEnabledCipherSuite(String suite)` Add an enabled cipher suite, appended to the ordered suites.
    `ConsulClientOptions` | ConsulClientOptions.`addEnabledSecureTransportProtocol(String protocol)` Add an enabled SSL/TLS protocols, appended to the ordered protocols.
    `ConsulClientOptions` | ConsulClientOptions.`removeEnabledSecureTransportProtocol(String protocol)`
    `ConsulClientOptions` | ConsulClientOptions.`setAclToken(String aclToken)` Set the ACL token.
    `ConsulClientOptions` | ConsulClientOptions.`setAlpnVersions(List<HttpVersion> alpnVersions)` Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
    `ConsulClientOptions` | ConsulClientOptions.`setConnectTimeout(int connectTimeout)` Set the connect timeout
    `ConsulClientOptions` | ConsulClientOptions.`setDc(String dc)` Set the datacenter name.
    `ConsulClientOptions` | ConsulClientOptions.`setDecoderInitialBufferSize(int decoderInitialBufferSize)` set to `initialBufferSizeHttpDecoder` the initial buffer of the HttpDecoder.
    `ConsulClientOptions` | ConsulClientOptions.`setDefaultHost(String defaultHost)` Set the default host name to be used by this client in requests if none is provided when making the request.
    `ConsulClientOptions` | ConsulClientOptions.`setDefaultPort(int defaultPort)` Set the default port to be used by this client in requests if none is provided when making the request.
    `ConsulClientOptions` | ConsulClientOptions.`setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)`
    `ConsulClientOptions` | ConsulClientOptions.`setFollowRedirects(boolean followRedirects)` Configure the default behavior of the client to follow HTTP `30x` redirections.
    `ConsulClientOptions` | ConsulClientOptions.`setForceSni(boolean forceSni)` 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.
    `ConsulClientOptions` | ConsulClientOptions.`setHost(String host)` Set Consul host.
    `ConsulClientOptions` | ConsulClientOptions.`setHttp2ClearTextUpgrade(boolean value)` 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).
    `ConsulClientOptions` | ConsulClientOptions.`setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)` Set the default HTTP/2 connection window size.
    `ConsulClientOptions` | ConsulClientOptions.`setHttp2KeepAliveTimeout(int keepAliveTimeout)`
    `ConsulClientOptions` | ConsulClientOptions.`setHttp2MaxPoolSize(int max)` Set the maximum pool size for HTTP/2 connections
    `ConsulClientOptions` | ConsulClientOptions.`setHttp2MultiplexingLimit(int limit)` 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.
    `ConsulClientOptions` | ConsulClientOptions.`setIdleTimeout(int idleTimeout)` Set the idle timeout, in seconds.
    `ConsulClientOptions` | ConsulClientOptions.`setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)` Set the idle timeout unit.
    `ConsulClientOptions` | ConsulClientOptions.`setInitialSettings(Http2Settings settings)` Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
    `ConsulClientOptions` | ConsulClientOptions.`setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)`
    `ConsulClientOptions` | ConsulClientOptions.`setKeepAlive(boolean keepAlive)` Set whether keep alive is enabled on the client
    `ConsulClientOptions` | ConsulClientOptions.`setKeepAliveTimeout(int keepAliveTimeout)`
    `ConsulClientOptions` | ConsulClientOptions.`setKeyCertOptions(KeyCertOptions options)` Set the key/cert options.
    `ConsulClientOptions` | ConsulClientOptions.`setKeyStoreOptions(JksOptions options)` Set the key/cert options in jks format, aka Java keystore.
    `ConsulClientOptions` | ConsulClientOptions.`setLocalAddress(String localAddress)` Set the local interface to bind for network connections.
    `ConsulClientOptions` | ConsulClientOptions.`setLogActivity(boolean logActivity)` Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
    `ConsulClientOptions` | ConsulClientOptions.`setMaxChunkSize(int maxChunkSize)` Set the maximum HTTP chunk size
    `ConsulClientOptions` | ConsulClientOptions.`setMaxHeaderSize(int maxHeaderSize)` Set the maximum length of all headers for HTTP/1.x .
    `ConsulClientOptions` | ConsulClientOptions.`setMaxInitialLineLength(int maxInitialLineLength)` Set the maximum length of the initial line for HTTP/1.x (e.g.
    `ConsulClientOptions` | ConsulClientOptions.`setMaxPoolSize(int maxPoolSize)` Set the maximum pool size for connections
    `ConsulClientOptions` | ConsulClientOptions.`setMaxRedirects(int maxRedirects)` Set to `maxRedirects` the maximum number of redirection a request can follow.
    `ConsulClientOptions` | ConsulClientOptions.`setMaxWaitQueueSize(int maxWaitQueueSize)` Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException.
    `ConsulClientOptions` | ConsulClientOptions.`setMaxWebsocketFrameSize(int maxWebsocketFrameSize)` Set the max websocket frame size
    `ConsulClientOptions` | ConsulClientOptions.`setMaxWebSocketFrameSize(int maxWebsocketFrameSize)`
    `ConsulClientOptions` | ConsulClientOptions.`setMaxWebsocketMessageSize(int maxWebsocketMessageSize)` Set the max websocket message size
    `ConsulClientOptions` | ConsulClientOptions.`setMaxWebSocketMessageSize(int maxWebsocketMessageSize)`
    `ConsulClientOptions` | ConsulClientOptions.`setMetricsName(String metricsName)` Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
    `ConsulClientOptions` | ConsulClientOptions.`setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)`
    `ConsulClientOptions` | ConsulClientOptions.`setPemKeyCertOptions(PemKeyCertOptions options)` Set the key/cert store options in pem format.
    `ConsulClientOptions` | ConsulClientOptions.`setPemTrustOptions(PemTrustOptions pemTrustOptions)` Set the trust options.
    `ConsulClientOptions` | ConsulClientOptions.`setPfxKeyCertOptions(PfxOptions options)` Set the key/cert options in pfx format.
    `ConsulClientOptions` | ConsulClientOptions.`setPfxTrustOptions(PfxOptions options)` Set the trust options in pfx format
    `ConsulClientOptions` | ConsulClientOptions.`setPipelining(boolean pipelining)` Set whether pipe-lining is enabled on the client
    `ConsulClientOptions` | ConsulClientOptions.`setPipeliningLimit(int limit)` Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
    `ConsulClientOptions` | ConsulClientOptions.`setPoolCleanerPeriod(int poolCleanerPeriod)`
    `ConsulClientOptions` | ConsulClientOptions.`setPort(int port)` Set Consul HTTP API port.
    `ConsulClientOptions` | ConsulClientOptions.`setProtocolVersion(HttpVersion protocolVersion)` Set the protocol version.
    `ConsulClientOptions` | ConsulClientOptions.`setProxyOptions(ProxyOptions proxyOptions)` Set proxy options for connections via CONNECT proxy (e.g.
    `ConsulClientOptions` | ConsulClientOptions.`setReceiveBufferSize(int receiveBufferSize)` Set the TCP receive buffer size
    `ConsulClientOptions` | ConsulClientOptions.`setReuseAddress(boolean reuseAddress)` Set the value of reuse address
    `ConsulClientOptions` | ConsulClientOptions.`setReusePort(boolean reusePort)` Set the value of reuse port.
    `ConsulClientOptions` | ConsulClientOptions.`setSendBufferSize(int sendBufferSize)` Set the TCP send buffer size
    `ConsulClientOptions` | ConsulClientOptions.`setSendUnmaskedFrames(boolean sendUnmaskedFrames)` Set true when the client wants to skip frame masking.
    `ConsulClientOptions` | ConsulClientOptions.`setSoLinger(int soLinger)` Set whether SO_linger keep alive is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setSsl(boolean ssl)` Set whether SSL/TLS is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setSslEngineOptions(SSLEngineOptions sslEngineOptions)` Set to use SSL engine implementation to use.
    `ConsulClientOptions` | ConsulClientOptions.`setSslHandshakeTimeout(long sslHandshakeTimeout)`
    `ConsulClientOptions` | ConsulClientOptions.`setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)`
    `ConsulClientOptions` | ConsulClientOptions.`setTcpCork(boolean tcpCork)` Enable the `TCP_CORK` option - only with linux native transport.
    `ConsulClientOptions` | ConsulClientOptions.`setTcpFastOpen(boolean tcpFastOpen)` Enable the `TCP_FASTOPEN` option - only with linux native transport.
    `ConsulClientOptions` | ConsulClientOptions.`setTcpKeepAlive(boolean tcpKeepAlive)` Set whether TCP keep alive is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setTcpNoDelay(boolean tcpNoDelay)` Set whether TCP no delay is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setTcpQuickAck(boolean tcpQuickAck)` Enable the `TCP_QUICKACK` option - only with linux native transport.
    `ConsulClientOptions` | ConsulClientOptions.`setTimeout(long timeoutMs)` 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.
    `ConsulClientOptions` | ConsulClientOptions.`setTrafficClass(int trafficClass)` Set the value of traffic class
    `ConsulClientOptions` | ConsulClientOptions.`setTrustAll(boolean trustAll)` Set whether all server certificates should be trusted
    `ConsulClientOptions` | ConsulClientOptions.`setTrustOptions(TrustOptions options)` Set the trust options.
    `ConsulClientOptions` | ConsulClientOptions.`setTrustStoreOptions(JksOptions options)` Set the trust options in jks format, aka Java truststore
    `ConsulClientOptions` | ConsulClientOptions.`setTryUseCompression(boolean tryUseCompression)` Set whether compression is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setTryUsePerFrameWebSocketCompression(boolean offer)`
    `ConsulClientOptions` | ConsulClientOptions.`setTryUsePerMessageWebSocketCompression(boolean offer)`
    `ConsulClientOptions` | ConsulClientOptions.`setUseAlpn(boolean useAlpn)` Set the ALPN usage.
    `ConsulClientOptions` | ConsulClientOptions.`setUsePooledBuffers(boolean usePooledBuffers)` Set whether Netty pooled buffers are enabled
    `ConsulClientOptions` | ConsulClientOptions.`setUserAgent(String userAgent)` Sets the Web Client user agent header.
    `ConsulClientOptions` | ConsulClientOptions.`setUserAgentEnabled(boolean userAgentEnabled)` Sets whether the Web Client should send a user agent header.
    `ConsulClientOptions` | ConsulClientOptions.`setVerifyHost(boolean verifyHost)` Set whether hostname verification is enabled
    `ConsulClientOptions` | ConsulClientOptions.`setWebSocketCompressionAllowClientNoContext(boolean offer)`
    `ConsulClientOptions` | ConsulClientOptions.`setWebSocketCompressionLevel(int compressionLevel)`
    `ConsulClientOptions` | ConsulClientOptions.`setWebSocketCompressionRequestServerNoContext(boolean offer)`

    Methods in io.vertx.ext.consul with parameters of type ConsulClientOptions
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`create(Vertx vertx, ConsulClientOptions options)` Create a Consul client.
    `static Watch<EventList>` | Watch.`events(String event, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the custom user events.
    `static void` | ConsulClientOptionsConverter.`fromJson(Iterable<Map.Entry<String,Object>> json, ConsulClientOptions obj)`
    `static Watch<KeyValue>` | Watch.`key(String key, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a specific key in the KV store.
    `static Watch<KeyValueList>` | Watch.`keyPrefix(String keyPrefix, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a prefix of keys in the KV store.
    `static Watch<NodeList>` | Watch.`nodes(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available nodes.
    `static Watch<ServiceEntryList>` | Watch.`service(String service, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the nodes providing the service.
    `static Watch<ServiceList>` | Watch.`services(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available services.
    `static void` | ConsulClientOptionsConverter.`toJson(ConsulClientOptions obj, JsonObject json)`
    `static void` | ConsulClientOptionsConverter.`toJson(ConsulClientOptions obj, Map<String,Object> json)`

    Constructors in io.vertx.ext.consul with parameters of type ConsulClientOptions
    Constructor and Description
    `ConsulClientOptions(ConsulClientOptions options)` Copy constructor

  - ### Uses of ConsulClientOptions in io.vertx.reactivex.ext.consul

    Methods in io.vertx.reactivex.ext.consul with parameters of type ConsulClientOptions
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`create(Vertx vertx, ConsulClientOptions options)` Create a Consul client.
    `static Watch<EventList>` | Watch.`events(String event, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the custom user events.
    `static Watch<KeyValue>` | Watch.`key(String key, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a specific key in the KV store.
    `static Watch<KeyValueList>` | Watch.`keyPrefix(String keyPrefix, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a prefix of keys in the KV store.
    `static Watch<NodeList>` | Watch.`nodes(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available nodes.
    `static Watch<ServiceEntryList>` | Watch.`service(String service, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the nodes providing the service.
    `static Watch<ServiceList>` | Watch.`services(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available services.

  - ### Uses of ConsulClientOptions in io.vertx.rxjava.ext.consul

    Methods in io.vertx.rxjava.ext.consul with parameters of type ConsulClientOptions
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`create(Vertx vertx, ConsulClientOptions options)` Create a Consul client.
    `static Watch<EventList>` | Watch.`events(String event, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the custom user events.
    `static Watch<KeyValue>` | Watch.`key(String key, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a specific key in the KV store.
    `static Watch<KeyValueList>` | Watch.`keyPrefix(String keyPrefix, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring a prefix of keys in the KV store.
    `static Watch<NodeList>` | Watch.`nodes(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available nodes.
    `static Watch<ServiceEntryList>` | Watch.`service(String service, Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the nodes providing the service.
    `static Watch<ServiceList>` | Watch.`services(Vertx vertx, ConsulClientOptions options)` Creates `Watch` to monitoring the list of available services.

Copyright © 2020 Eclipse. All rights reserved.