= Cheatsheets [[AclToken]] == AclToken ++++ Holds properties of Acl token ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[id]]`@id`|`String`|+++ Set ID of token +++ |[[name]]`@name`|`String`|+++ Set name of token +++ |[[rules]]`@rules`|`String`|+++ Set rules for token +++ |[[type]]`@type`|`link:enums.html#AclTokenType[AclTokenType]`|+++ Set type of token +++ |=== [[AddressResolverOptions]] == AddressResolverOptions ++++ Configuration options for Vert.x hostname resolver. The resolver uses the local <i>hosts</i> file and performs DNS <i>A</i> and <i>AAAA</i> queries. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[cacheMaxTimeToLive]]`@cacheMaxTimeToLive`|`Number (int)`|+++ Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL, use this to set a maximum value to all responses TTL. +++ |[[cacheMinTimeToLive]]`@cacheMinTimeToLive`|`Number (int)`|+++ Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL, use this to set a minimum value to all responses TTL. +++ |[[cacheNegativeTimeToLive]]`@cacheNegativeTimeToLive`|`Number (int)`|+++ Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies and reduce the amount of messages to DNS servers. +++ |[[hostsPath]]`@hostsPath`|`String`|+++ Set the path of an alternate hosts configuration file to use instead of the one provided by the os. <p/> The default value is null, so the operating system hosts config is used. +++ |[[hostsValue]]`@hostsValue`|`Buffer`|+++ Set an alternate hosts configuration file to use instead of the one provided by the os. <p/> The value should contain the hosts content literaly, for instance <i>127.0.0.1 localhost</i> <p/> The default value is null, so the operating system hosts config is used. +++ |[[maxQueries]]`@maxQueries`|`Number (int)`|+++ Set the maximum number of queries when an hostname is resolved. +++ |[[ndots]]`@ndots`|`Number (int)`|+++ Set the ndots value used when resolving using search domains, the default value is <code>-1</code> which determines the value from the OS on Linux or uses the value <code>1</code>. +++ |[[optResourceEnabled]]`@optResourceEnabled`|`Boolean`|+++ Set to true to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response. +++ |[[queryTimeout]]`@queryTimeout`|`Number (long)`|+++ Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed. +++ |[[rdFlag]]`@rdFlag`|`Boolean`|+++ Set the DNS queries <i>Recursion Desired</i> flag value. +++ |[[rotateServers]]`@rotateServers`|`Boolean`|+++ Set to <code>true</code> to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list. +++ |[[roundRobinInetAddress]]`@roundRobinInetAddress`|`Boolean`|+++ Set to <code>true</code> to enable round-robin inet address selection of the ip address to use. +++ |[[searchDomains]]`@searchDomains`|`Array of String`|+++ Set the lists of DNS search domains. <p/> When the search domain list is null, the effective search domain list will be populated using the system DNS search domains. +++ |[[servers]]`@servers`|`Array of String`|+++ Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port, e.g <code>8.8.8.8</code> or {code 192.168.0.1:40000}. When the list is empty, the resolver will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved it will use Google's public DNS servers <code>"8.8.8.8"</code> and <code>"8.8.4.4"</code>. +++ |=== [[AggregateOptions]] == AggregateOptions ++++ Options used to configure aggregate operations. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[allowDiskUse]]`@allowDiskUse`|`Boolean`|+++ Set the flag if writing to temporary files is enabled. +++ |[[batchSize]]`@batchSize`|`Number (int)`|+++ Set the batch size for methods loading found data in batches. +++ |[[maxAwaitTime]]`@maxAwaitTime`|`Number (long)`|+++ The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation. +++ |[[maxTime]]`@maxTime`|`Number (long)`|+++ Set the time limit in milliseconds for processing operations on a cursor. +++ |=== [[AmqpBridgeOptions]] == AmqpBridgeOptions ++++ Options for configuring the AmqpBridge. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[containerId]]`@containerId`|`String`|+++ Sets the value to use as the container-id field in the AMQP Open frame. Some servers and clients use this for the concept of a 'Client ID'. Defaults to null, which indicates a value will be generated by the bridge when the underlying connection is made. +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSaslMechanisms]]`@enabledSaslMechanisms`|`Array of String`|- |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[heartbeat]]`@heartbeat`|`Number (int)`|- |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxFrameSize]]`@maxFrameSize`|`Number (int)`|- |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Set the value of reconnect attempts +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval +++ |[[replyHandlingSupport]]`@replyHandlingSupport`|`Boolean`|+++ Sets whether the bridge should try to enable support for sending messages with a reply handler set, and replying to messages using the message reply methods. Defaults to true. If the server does not advertise support for 'anonymous sender' links then the bridge won't support reply handling regardless of this setting. +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sniServerName]]`@sniServerName`|`String`|- |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[vhost]]`@vhost`|`String`|+++ Sets the value to use as the hostname field in the AMQP Open frame. Defaults to null, which indicates the hostname value given when starting the bridge will be used to populate the hostname field. +++ |[[virtualHost]]`@virtualHost`|`String`|- |=== [[AmqpClientOptions]] == AmqpClientOptions ++++ Configures the AMQP Client. You can also configure the underlying Proton instance. Refer to for details. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ +++ |[[connectionHostname]]`@connectionHostname`|`String`|+++ Explicitly override the hostname value used for the AMQP Open frame. The host connected to as per link will be used in the Open frame by default. +++ |[[containerId]]`@containerId`|`String`|+++ Sets the container id. +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ +++ |[[enabledSaslMechanisms]]`@enabledSaslMechanisms`|`Array of String`|+++ +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ +++ |[[heartbeat]]`@heartbeat`|`Number (int)`|+++ +++ |[[host]]`@host`|`String`|+++ Sets the host. +++ |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|+++ +++ |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ +++ |[[localAddress]]`@localAddress`|`String`|+++ +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxFrameSize]]`@maxFrameSize`|`Number (int)`|+++ +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|+++ +++ |[[password]]`@password`|`String`|+++ Sets the password. +++ |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ +++ |[[port]]`@port`|`Number (int)`|+++ Sets the port. +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ +++ |[[sniServerName]]`@sniServerName`|`String`|+++ +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ +++ |[[ssl]]`@ssl`|`Boolean`|+++ +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ +++ |[[username]]`@username`|`String`|+++ Sets the username. +++ |[[virtualHost]]`@virtualHost`|`String`|+++ +++ |=== [[AmqpReceiverOptions]] == AmqpReceiverOptions ++++ Configures the AMQP Receiver. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[autoAcknowledgement]]`@autoAcknowledgement`|`Boolean`|+++ Sets the auto-acknowledgement. When enabled (default), the messages are automatically acknowledged. If set to <code>false</code>, the messages must be acknowledged explicitly using link, link and link. +++ |[[capabilities]]`@capabilities`|`Array of String`|+++ Sets the list of capabilities to be set on the receiver source terminus. +++ |[[capabilitys]]`@capabilitys`|`Array of String`|+++ Adds a capability to be set on the receiver source terminus. +++ |[[durable]]`@durable`|`Boolean`|+++ Sets the durability. <p> Passing <code>true</code> sets the expiry policy of the source to <code>NEVER</code> and the durability of the source to <code>UNSETTLED_STATE</code>. +++ |[[dynamic]]`@dynamic`|`Boolean`|+++ Sets whether the Source terminus to be used should specify it is 'dynamic', requesting the peer creates a node and names it with a generated address. <p> The address provided by the peer can then be inspected using the link method on the link received once opened. +++ |[[linkName]]`@linkName`|`String`|- |[[maxBufferedMessages]]`@maxBufferedMessages`|`Number (int)`|+++ Sets the max buffered messages. This message can be used to configure the initial credit of a receiver. +++ |[[qos]]`@qos`|`String`|+++ Sets the local QOS config. +++ |=== [[AmqpSenderOptions]] == AmqpSenderOptions ++++ Configures the AMQP Sender. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[autoDrained]]`@autoDrained`|`Boolean`|+++ Sets whether the link is automatically marked drained after the send queue drain handler callback returns if the receiving peer requested that credit be drained. <p> <code>true</code> by default. +++ |[[capabilities]]`@capabilities`|`Array of String`|+++ Sets the list of capabilities to be set on the sender target terminus. +++ |[[capabilitys]]`@capabilitys`|`Array of String`|+++ Adds a capability to be set on the sender target terminus. +++ |[[dynamic]]`@dynamic`|`Boolean`|+++ Sets whether the Target terminus to be used should specify it is 'dynamic', requesting the peer creates a node and names it with a generated address. <p> The address provided by the peer can then be inspected using the link method on the link received once opened. +++ |[[linkName]]`@linkName`|`String`|- |=== [[ApolloWSOptions]] == ApolloWSOptions ++++ Options for configuring the link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[keepAlive]]`@keepAlive`|`Number (long)`|+++ Set the interval in milliseconds to send <code>KEEPALIVE</code> messages to all clients. Defaults to <code>30000</code>. +++ |=== [[Argument]] == Argument ++++ Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The first index is 0 (because we are in the computer world). ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[argName]]`@argName`|`String`|+++ Sets the argument name of this link. +++ |[[defaultValue]]`@defaultValue`|`String`|+++ Sets the default value of this link. +++ |[[description]]`@description`|`String`|+++ Sets the description of the link. +++ |[[hidden]]`@hidden`|`Boolean`|+++ Sets whether or not the current link is hidden. +++ |[[index]]`@index`|`Number (int)`|+++ Sets the argument index. +++ |[[multiValued]]`@multiValued`|`Boolean`|+++ Sets whether or not the argument can receive several values. Only the last argument can receive several values. +++ |[[required]]`@required`|`Boolean`|+++ Sets whether or not the current link is required. +++ |=== [[AuthOptions]] == AuthOptions ++++ A common base object for authentication options.<p> ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |=== [[BitFieldGetCommand]] == BitFieldGetCommand ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[offset]]`@offset`|`Number (long)`|- |[[type]]`@type`|`String`|- |=== [[BitFieldIncrbyCommand]] == BitFieldIncrbyCommand ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[increment]]`@increment`|`Number (long)`|- |[[offset]]`@offset`|`Number (long)`|- |[[type]]`@type`|`String`|- |=== [[BitFieldOptions]] == BitFieldOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[get]]`@get`|`link:dataobjects.html#BitFieldGetCommand[BitFieldGetCommand]`|- |[[incrby]]`@incrby`|`link:dataobjects.html#BitFieldIncrbyCommand[BitFieldIncrbyCommand]`|- |[[set]]`@set`|`link:dataobjects.html#BitFieldSetCommand[BitFieldSetCommand]`|- |=== [[BitFieldSetCommand]] == BitFieldSetCommand ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[offset]]`@offset`|`Number (long)`|- |[[type]]`@type`|`String`|- |[[value]]`@value`|`Number (long)`|- |=== [[BlockingQueryOptions]] == BlockingQueryOptions ++++ Options used to perform blocking query that used to wait for a potential change using long polling. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set index indicating that the client wishes to wait for any changes subsequent to that index. +++ |[[wait]]`@wait`|`String`|+++ Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively). +++ |=== [[Box]] == Box ++++ Rectangular box data type in Postgres represented by pairs of links that are opposite corners of the box. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[lowerLeftCorner]]`@lowerLeftCorner`|`link:dataobjects.html#Point[Point]`|- |[[upperRightCorner]]`@upperRightCorner`|`link:dataobjects.html#Point[Point]`|- |=== [[BridgeOptions]] == BridgeOptions ++++ Specify the event bus bridge options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[inboundPermitteds]]`@inboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|+++ Sets the list of inbound permitted options. +++ |[[outboundPermitteds]]`@outboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|+++ Sets the list of outbound permitted options. +++ |=== [[BridgeOptions]] == BridgeOptions ++++ Specify the event bus bridge options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[inboundPermitteds]]`@inboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|+++ Sets the list of inbound permitted options. +++ |[[outboundPermitteds]]`@outboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|+++ Sets the list of outbound permitted options. +++ |[[pointToPoint]]`@pointToPoint`|`Boolean`|- |=== [[BridgeOptions]] == BridgeOptions ++++ Deprecated: use link instead. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[inboundPermitted]]`@inboundPermitted`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|- |[[inboundPermitteds]]`@inboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|- |[[maxAddressLength]]`@maxAddressLength`|`Number (int)`|- |[[maxHandlersPerSocket]]`@maxHandlersPerSocket`|`Number (int)`|- |[[outboundPermitted]]`@outboundPermitted`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|- |[[outboundPermitteds]]`@outboundPermitteds`|`Array of link:dataobjects.html#PermittedOptions[PermittedOptions]`|- |[[pingTimeout]]`@pingTimeout`|`Number (long)`|- |[[replyTimeout]]`@replyTimeout`|`Number (long)`|- |=== [[BulkOperation]] == BulkOperation ++++ Contains all data needed for one operation of a bulk write operation. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[document]]`@document`|`Json object`|+++ Sets the document, used by insert, replace, and update operations +++ |[[filter]]`@filter`|`Json object`|+++ Sets the filter document, used by replace, update, and delete operations +++ |[[multi]]`@multi`|`Boolean`|+++ Sets the multi flag, used by update and delete operations +++ |[[type]]`@type`|`link:enums.html#BulkOperationType[BulkOperationType]`|+++ Sets the operation type +++ |[[upsert]]`@upsert`|`Boolean`|+++ Sets the upsert flag, used by update and replace operations +++ |=== [[BulkWriteOptions]] == BulkWriteOptions ++++ Options for configuring bulk write operations. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[ordered]]`@ordered`|`Boolean`|+++ Set the ordered option +++ |[[writeOption]]`@writeOption`|`link:enums.html#WriteOption[WriteOption]`|+++ Set the write option +++ |=== [[CassandraClientOptions]] == CassandraClientOptions ++++ Eclipse Vert.x Cassandra client options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[contactPoints]]`@contactPoints`|`Array of String`|+++ Set a list of hosts, where some of cluster nodes is located. +++ |[[keyspace]]`@keyspace`|`String`|+++ Set the keyspace to use when creating the Cassandra session. Defaults to <code>null</code>. +++ |[[port]]`@port`|`Number (int)`|+++ Set which port should be used for all the hosts to connect to a cassandra service. +++ |=== [[Check]] == Check ++++ Holds check properties ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[id]]`@id`|`String`|+++ Set the ID of check +++ |[[name]]`@name`|`String`|+++ Set the name of check +++ |[[nodeName]]`@nodeName`|`String`|+++ Set the name of node +++ |[[notes]]`@notes`|`String`|+++ Set the human-readable note of check +++ |[[output]]`@output`|`String`|+++ Set the output of check +++ |[[serviceId]]`@serviceId`|`String`|+++ Set the ID of service with which this check associated +++ |[[serviceName]]`@serviceName`|`String`|+++ Set the name of service with which this check associated +++ |[[status]]`@status`|`link:enums.html#CheckStatus[CheckStatus]`|+++ Set the status of check +++ |=== [[CheckList]] == CheckList ++++ Holds result of checks query ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set Consul index, a unique identifier representing the current state of the requested list of checks +++ |[[list]]`@list`|`Array of link:dataobjects.html#Check[Check]`|+++ Set list of checks +++ |=== [[CheckOptions]] == CheckOptions ++++ Options used to register checks in Consul. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[deregisterAfter]]`@deregisterAfter`|`String`|+++ Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. If a check is associated with a service and has the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service. +++ |[[grpc]]`@grpc`|`String`|+++ Specifies a gRPC check's endpoint that supports the standard <a href="https://github.com/grpc/grpc/blob/master/doc/health-checking.md">gRPC health checking protocol</a>. The state of the check will be updated at the given Interval by probing the configured endpoint. The endpoint must be represented as <code>address:port/service</code> +++ |[[grpcTls]]`@grpcTls`|`Boolean`|+++ Specifies whether to use TLS for this gRPC health check. If TLS is enabled, then by default, a valid TLS certificate is expected. Certificate verification can be turned off by setting <code>TLSSkipVerify</code> to <code>true</code>. +++ |[[http]]`@http`|`String`|+++ Set HTTP address to check. Also you should set checking interval +++ |[[id]]`@id`|`String`|+++ Set check ID +++ |[[interval]]`@interval`|`String`|+++ Set checking interval +++ |[[name]]`@name`|`String`|+++ Set check name. This is mandatory field +++ |[[notes]]`@notes`|`String`|+++ Set check notes +++ |[[scriptArgs]]`@scriptArgs`|`Array of String`|+++ Set scriptArgs. Also you should set checking interval +++ |[[serviceId]]`@serviceId`|`String`|+++ Set the service ID to associate the registered check with an existing service provided by the agent. +++ |[[status]]`@status`|`link:enums.html#CheckStatus[CheckStatus]`|+++ Set the check status to specify the initial state of the health check. +++ |[[tcp]]`@tcp`|`String`|+++ Set TCP address to check. Also you should set checking interval +++ |[[tlsSkipVerify]]`@tlsSkipVerify`|`Boolean`|+++ Specifies if the certificate for an HTTPS check should not be verified. +++ |[[ttl]]`@ttl`|`String`|+++ Set Time to Live of check. +++ |=== [[CheckQueryOptions]] == CheckQueryOptions ++++ Options used to requesting list of checks ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[blockingOptions]]`@blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|+++ Set options for blocking query +++ |[[near]]`@near`|`String`|+++ Set node name for sorting the list in ascending order based on the estimated round trip time from that node. +++ |=== [[Circle]] == Circle ++++ Circle data type in Postgres represented by a center link and radius. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[centerPoint]]`@centerPoint`|`link:dataobjects.html#Point[Point]`|- |[[radius]]`@radius`|`Number (double)`|- |=== [[CircuitBreakerOptions]] == CircuitBreakerOptions ++++ Circuit breaker configuration options. All time are given in milliseconds. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[failuresRollingWindow]]`@failuresRollingWindow`|`Number (long)`|+++ Sets the rolling window used for metrics. +++ |[[fallbackOnFailure]]`@fallbackOnFailure`|`Boolean`|+++ Sets whether or not the fallback is executed on failure, even when the circuit is closed. +++ |[[maxFailures]]`@maxFailures`|`Number (int)`|+++ Sets the maximum number of failures before opening the circuit. +++ |[[maxRetries]]`@maxRetries`|`Number (int)`|+++ Configures the number of times the circuit breaker tries to redo the operation before failing. +++ |[[metricsRollingBuckets]]`@metricsRollingBuckets`|`Number (int)`|+++ Sets the configured number of buckets the rolling window is divided into. The following must be true - metrics.rollingStats.timeInMilliseconds % metrics.rollingStats.numBuckets == 0 - otherwise it will throw an exception. In other words, 10000/10 is okay, so is 10000/20 but 10000/7 is not. +++ |[[metricsRollingWindow]]`@metricsRollingWindow`|`Number (long)`|+++ Sets the rolling window used for metrics. +++ |[[notificationAddress]]`@notificationAddress`|`String`|+++ Sets the event bus address on which the circuit breaker publish its state change. +++ |[[notificationPeriod]]`@notificationPeriod`|`Number (long)`|+++ Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its current state. +++ |[[resetTimeout]]`@resetTimeout`|`Number (long)`|+++ Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state). If the circuit is closed when the timeout is reached, nothing happens. <code>-1</code> disables this feature. +++ |[[timeout]]`@timeout`|`Number (long)`|+++ Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as a failure. +++ |=== [[ClientOptionsBase]] == ClientOptionsBase ++++ Base class for Client options ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |=== [[ClusterDescription]] == ClusterDescription ++++ A detailed description of the cluster ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[clusterId]]`@clusterId`|`String`|+++ Set the cluster ID +++ |[[controller]]`@controller`|`link:dataobjects.html#Node[Node]`|+++ Set the controller node. +++ |[[nodes]]`@nodes`|`Array of link:dataobjects.html#Node[Node]`|+++ Set the nodes belonging to this cluster +++ |=== [[Config]] == Config ++++ A configuration object containing the configuration entries for a resource ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[entries]]`@entries`|`Array of link:dataobjects.html#ConfigEntry[ConfigEntry]`|+++ Set the configuration entries for a resource +++ |=== [[ConfigChange]] == ConfigChange ++++ A structure representing a configuration change. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[newConfiguration]]`@newConfiguration`|`Json object`|+++ Sets the new configuration. +++ |[[previousConfiguration]]`@previousConfiguration`|`Json object`|+++ Sets the previous configuration. +++ |=== [[ConfigEntry]] == ConfigEntry ++++ A class representing a configuration entry containing name, value and additional metadata ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[default]]`@default`|`Boolean`|+++ Set whether the config value is the default or if it's been explicitly set +++ |[[name]]`@name`|`String`|+++ Set the config name +++ |[[readOnly]]`@readOnly`|`Boolean`|+++ Set whether the config is read-only and cannot be updated +++ |[[sensitive]]`@sensitive`|`Boolean`|+++ Set whether the config value is sensitive. The value is always set to null by the broker if the config value is sensitive +++ |[[source]]`@source`|`link:enums.html#ConfigSource[ConfigSource]`|+++ Set the source of this configuration entry +++ |[[synonyms]]`@synonyms`|`Array of link:dataobjects.html#ConfigSynonym[ConfigSynonym]`|+++ Set all config values that may be used as the value of this config along with their source, in the order of precedence +++ |[[value]]`@value`|`String`|+++ Set the value or null. Null is returned if the config is unset or if isSensitive is true +++ |=== [[ConfigResource]] == ConfigResource ++++ A class representing resources that have configuration ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[default]]`@default`|`Boolean`|+++ Set if this is the default resource of a resource type. Resource name is empty for the default resource. +++ |[[name]]`@name`|`String`|+++ Set the resource name +++ |[[type]]`@type`|`link:enums.html#Type[Type]`|+++ Set the resource type +++ |=== [[ConfigRetrieverOptions]] == ConfigRetrieverOptions ++++ Options to configure the <code>ConfigRetriever</code>. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[includeDefaultStores]]`@includeDefaultStores`|`Boolean`|+++ Enables or disables the inclusion of the default stored in the configuration. +++ |[[scanPeriod]]`@scanPeriod`|`Number (long)`|+++ Configures the scan period, in ms. This is the time amount between two checks of the configuration updates. +++ |[[stores]]`@stores`|`Array of link:dataobjects.html#ConfigStoreOptions[ConfigStoreOptions]`|+++ Sets the configuration stores. +++ |=== [[ConfigStoreOptions]] == ConfigStoreOptions ++++ Data object representing the configuration of a configuration store. This object describes the configuration of a chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the retrieved configuration chunk, and you can also configures the store if it needs configuration to retrieve the configuration chunk. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[config]]`@config`|`Json object`|+++ Sets the configuration of the store +++ |[[format]]`@format`|`String`|+++ Sets the format of the configuration that is retrieved from the store. +++ |[[optional]]`@optional`|`Boolean`|+++ Sets whether or not the store is optional. When the configuration is retrieve, if an optional store returns a failure, the failure is ignored and an empty json object is used instead (for this store). +++ |[[type]]`@type`|`String`|+++ Sets the configuration type +++ |=== [[ConfigSynonym]] == ConfigSynonym ++++ Class representing a configuration synonym of a link ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[name]]`@name`|`String`|+++ Set the name of this configuration +++ |[[source]]`@source`|`link:enums.html#ConfigSource[ConfigSource]`|+++ Set the source of this configuration +++ |[[value]]`@value`|`String`|+++ Set the value of this configuration, which may be null if the configuration is sensitive +++ |=== [[ConsulClientOptions]] == ConsulClientOptions ++++ Options used to create Consul client. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[aclToken]]`@aclToken`|`String`|+++ 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. +++ |[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|+++ 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 link: <ul> <li>: [ "h2", "http/1.1" ]</li> <li>otherwise: [link]</li> </ul> +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[dc]]`@dc`|`String`|+++ 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. +++ |[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|+++ set to <code>initialBufferSizeHttpDecoder</code> the initial buffer of the HttpDecoder. +++ |[[defaultHost]]`@defaultHost`|`String`|+++ Set the default host name to be used by this client in requests if none is provided when making the request. +++ |[[defaultPort]]`@defaultPort`|`Number (int)`|+++ Set the default port to be used by this client in requests if none is provided when making the request. +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[followRedirects]]`@followRedirects`|`Boolean`|+++ Configure the default behavior of the client to follow HTTP <code>30x</code> redirections. +++ |[[forceSni]]`@forceSni`|`Boolean`|+++ By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to <code>true</code> forces the server name to be always sent. +++ |[[http2ClearTextUpgrade]]`@http2ClearTextUpgrade`|`Boolean`|+++ Set to <code>true</code> when an <i>h2c</i> connection is established using an HTTP/1.1 upgrade request, and <code>false</code> when an <i>h2c</i> connection is established directly (with prior knowledge). +++ |[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|+++ 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. <p/> A value of <code>-1</code> reuses the initial window size setting. +++ |[[http2KeepAliveTimeout]]`@http2KeepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/2 connections, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[http2MaxPoolSize]]`@http2MaxPoolSize`|`Number (int)`|+++ Set the maximum pool size for HTTP/2 connections +++ |[[http2MultiplexingLimit]]`@http2MultiplexingLimit`|`Number (int)`|+++ 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. <p/> Setting the value to <code>-1</code> means to use the value sent by the server's initial settings. <code>-1</code> is the default value. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ 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. +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|+++ Set the HTTP/2 connection settings immediately sent by to the server when the client connects. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keepAlive]]`@keepAlive`|`Boolean`|+++ Set whether keep alive is enabled on the client +++ |[[keepAliveTimeout]]`@keepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/1.x, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|+++ Set the maximum HTTP chunk size +++ |[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|+++ Set the maximum length of all headers for HTTP/1.x . +++ |[[maxInitialLineLength]]`@maxInitialLineLength`|`Number (int)`|+++ Set the maximum length of the initial line for HTTP/1.x (e.g. <code>"HTTP/1.1 200 OK"</code>) +++ |[[maxPoolSize]]`@maxPoolSize`|`Number (int)`|+++ Set the maximum pool size for connections +++ |[[maxRedirects]]`@maxRedirects`|`Number (int)`|+++ Set to <code>maxRedirects</code> the maximum number of redirection a request can follow. +++ |[[maxWaitQueueSize]]`@maxWaitQueueSize`|`Number (int)`|+++ 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. +++ |[[maxWebSocketFrameSize]]`@maxWebSocketFrameSize`|`Number (int)`|+++ Set the max WebSocket frame size +++ |[[maxWebSocketMessageSize]]`@maxWebSocketMessageSize`|`Number (int)`|+++ Set the max WebSocket message size +++ |[[maxWebsocketFrameSize]]`@maxWebsocketFrameSize`|`Number (int)`|+++ Set the max websocket frame size +++ |[[maxWebsocketMessageSize]]`@maxWebsocketMessageSize`|`Number (int)`|+++ Set the max websocket message size +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options. +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[pipelining]]`@pipelining`|`Boolean`|+++ Set whether pipe-lining is enabled on the client +++ |[[pipeliningLimit]]`@pipeliningLimit`|`Number (int)`|+++ Set the limit of pending requests a pipe-lined HTTP/1 connection can send. +++ |[[poolCleanerPeriod]]`@poolCleanerPeriod`|`Number (int)`|+++ 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. +++ |[[protocolVersion]]`@protocolVersion`|`link:enums.html#HttpVersion[HttpVersion]`|+++ Set the protocol version. +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sendUnmaskedFrames]]`@sendUnmaskedFrames`|`Boolean`|+++ 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. +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[timeout]]`@timeout`|`Number (long)`|+++ 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. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[tryUseCompression]]`@tryUseCompression`|`Boolean`|+++ Set whether compression is enabled +++ |[[tryUsePerFrameWebSocketCompression]]`@tryUsePerFrameWebSocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-frame deflate compression extension. +++ |[[tryUsePerFrameWebsocketCompression]]`@tryUsePerFrameWebsocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-frame deflate compression extension. +++ |[[tryUsePerMessageWebSocketCompression]]`@tryUsePerMessageWebSocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-message deflate compression extension. +++ |[[tryUsePerMessageWebsocketCompression]]`@tryUsePerMessageWebsocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-message deflate compression extension. +++ |[[tryWebSocketDeflateFrameCompression]]`@tryWebSocketDeflateFrameCompression`|`Boolean`|+++ +++ |[[tryWebsocketDeflateFrameCompression]]`@tryWebsocketDeflateFrameCompression`|`Boolean`|+++ +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[userAgent]]`@userAgent`|`String`|+++ Sets the Web Client user agent header. Defaults to Vert.x-WebClient/&lt;version&gt;. +++ |[[userAgentEnabled]]`@userAgentEnabled`|`Boolean`|+++ Sets whether the Web Client should send a user agent header. Defaults to true. +++ |[[verifyHost]]`@verifyHost`|`Boolean`|+++ Set whether hostname verification is enabled +++ |[[webSocketClosingTimeout]]`@webSocketClosingTimeout`|`Number (int)`|+++ Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame. <p> When a WebSocket is closed, the server should close the TCP connection. This timeout will close the TCP connection on the client when it expires. <p> Set to <code>0L</code> closes the TCP connection immediately after receiving the close frame. <p> Set to a negative value to disable it. +++ |[[webSocketCompressionAllowClientNoContext]]`@webSocketCompressionAllowClientNoContext`|`Boolean`|+++ Set whether the <code>client_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[webSocketCompressionLevel]]`@webSocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket deflate compression level. +++ |[[webSocketCompressionRequestServerNoContext]]`@webSocketCompressionRequestServerNoContext`|`Boolean`|+++ Set whether the <code>server_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[websocketCompressionAllowClientNoContext]]`@websocketCompressionAllowClientNoContext`|`Boolean`|+++ Set whether the <code>client_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[websocketCompressionLevel]]`@websocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket deflate compression level. +++ |[[websocketCompressionRequestServerNoContext]]`@websocketCompressionRequestServerNoContext`|`Boolean`|+++ Set whether the <code>server_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |=== [[ConsumerGroupDescription]] == ConsumerGroupDescription ++++ A detailed description of a single consumer group in the cluster ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[coordinator]]`@coordinator`|`link:dataobjects.html#Node[Node]`|+++ Set the consumer group coordinator, or null if the coordinator is not known +++ |[[groupId]]`@groupId`|`String`|+++ Set the id of the consumer group +++ |[[members]]`@members`|`Array of link:dataobjects.html#MemberDescription[MemberDescription]`|+++ Set a list of the members of the consumer group +++ |[[partitionAssignor]]`@partitionAssignor`|`String`|+++ Set the consumer group partition assignor +++ |[[simpleConsumerGroup]]`@simpleConsumerGroup`|`Boolean`|+++ Set if consumer group is simple or not +++ |[[state]]`@state`|`link:enums.html#ConsumerGroupState[ConsumerGroupState]`|+++ Set the consumer group state, or UNKNOWN if the state is too new for us to parse +++ |=== [[ConsumerGroupListing]] == ConsumerGroupListing ++++ A listing of a consumer group in the cluster. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[groupId]]`@groupId`|`String`|+++ Set the consumer group id +++ |[[simpleConsumerGroup]]`@simpleConsumerGroup`|`Boolean`|+++ Set if consumer group is simple or not +++ |=== [[Coordinate]] == Coordinate ++++ Holds network coordinates of node ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[adj]]`@adj`|`Number (float)`|+++ Set adjustment +++ |[[err]]`@err`|`Number (float)`|+++ Set error +++ |[[height]]`@height`|`Number (float)`|+++ Set height +++ |[[node]]`@node`|`String`|+++ Set name of node +++ |[[vec]]`@vec`|`Array of Number (Float)`|+++ Set vector +++ |=== [[CoordinateList]] == CoordinateList ++++ Holds result of network coordinates query ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set Consul index, a unique identifier representing the current state of the requested coordinates +++ |[[list]]`@list`|`Array of link:dataobjects.html#Coordinate[Coordinate]`|+++ Set list of coordinates +++ |=== [[CopyOptions]] == CopyOptions ++++ Describes the copy (and move) options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[atomicMove]]`@atomicMove`|`Boolean`|+++ Whether move should be performed as an atomic filesystem operation. Defaults to <code>false</code>. +++ |[[copyAttributes]]`@copyAttributes`|`Boolean`|+++ Whether the file attributes should be copied. Defaults to <code>false</code>. +++ |[[nofollowLinks]]`@nofollowLinks`|`Boolean`|+++ Whether symbolic links should not be followed during copy or move operations. Defaults to <code>false</code>. +++ |[[replaceExisting]]`@replaceExisting`|`Boolean`|+++ Whether an existing file, empty directory, or link should be replaced. Defaults to <code>false</code>. +++ |=== [[DB2ConnectOptions]] == DB2ConnectOptions ++++ Connect options for configuring link or link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[cachePreparedStatements]]`@cachePreparedStatements`|`Boolean`|+++ Set whether prepared statements cache should be enabled. +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[database]]`@database`|`String`|+++ Specify the default database for the connection. +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[host]]`@host`|`String`|+++ Specify the host for connecting to the server. +++ |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[password]]`@password`|`String`|+++ Specify the user password to be used for the authentication. +++ |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[pipeliningLimit]]`@pipeliningLimit`|`Number (int)`|- |[[port]]`@port`|`Number (int)`|+++ Specify the port for connecting to the server. +++ |[[preparedStatementCacheMaxSize]]`@preparedStatementCacheMaxSize`|`Number (int)`|+++ Set the maximum number of prepared statements that the connection will cache. +++ |[[preparedStatementCacheSqlLimit]]`@preparedStatementCacheSqlLimit`|`Number (int)`|+++ Set the maximum length of prepared statement SQL string that the connection will cache. <p> This is an helper setting the link. +++ |[[properties]]`@properties`|`String`|+++ Set properties for this client, which will be sent to server at the connection start. +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Set the value of reconnect attempts +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[user]]`@user`|`String`|+++ Specify the user account to be used for the authentication. +++ |=== [[DatagramSocketOptions]] == DatagramSocketOptions ++++ Options used to configure a datagram socket. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[broadcast]]`@broadcast`|`Boolean`|+++ Set if the socket can send or receive broadcast packets +++ |[[ipV6]]`@ipV6`|`Boolean`|+++ Set if IP v6 should be used +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[loopbackModeDisabled]]`@loopbackModeDisabled`|`Boolean`|+++ Set if loopback mode is disabled +++ |[[multicastNetworkInterface]]`@multicastNetworkInterface`|`String`|+++ Set the multicast network interface address +++ |[[multicastTimeToLive]]`@multicastTimeToLive`|`Number (int)`|+++ Set the multicast ttl value +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |=== [[DcCoordinates]] == DcCoordinates ++++ Holds coordinates of servers in datacenter ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[datacenter]]`@datacenter`|`String`|+++ Set datacenter +++ |[[servers]]`@servers`|`Array of link:dataobjects.html#Coordinate[Coordinate]`|+++ Set list of servers in datacenter +++ |=== [[DeliveryOptions]] == DeliveryOptions ++++ Delivery options are used to configure message delivery. <p> Delivery options allow to configure delivery timeout and message codec name, and to provide any headers that you wish to send with the message. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[codecName]]`@codecName`|`String`|+++ Set the codec name. +++ |[[headers]]`@headers`|`String`|+++ Add a message header. <p> Message headers can be sent with any message and will be accessible with link at the recipient. +++ |[[localOnly]]`@localOnly`|`Boolean`|+++ Whether a message should be delivered to local consumers only. Defaults to <code>false</code>. <p> <strong>This option is effective in clustered mode only and does not apply to reply messages</strong>. +++ |[[sendTimeout]]`@sendTimeout`|`Number (long)`|+++ Set the send timeout. +++ |=== [[DeploymentOptions]] == DeploymentOptions ++++ Options for configuring a verticle deployment. <p> ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[config]]`@config`|`Json object`|+++ Set the JSON configuration that will be passed to the verticle(s) when it's deployed +++ |[[extraClasspath]]`@extraClasspath`|`Array of String`|+++ Set any extra classpath to be used when deploying the verticle. <p> Ignored if no isolation group is set. +++ |[[ha]]`@ha`|`Boolean`|+++ Set whether the verticle(s) will be deployed as HA. +++ |[[instances]]`@instances`|`Number (int)`|+++ Set the number of instances that should be deployed. +++ |[[isolatedClasses]]`@isolatedClasses`|`Array of String`|+++ Set the isolated class names. +++ |[[isolationGroup]]`@isolationGroup`|`String`|+++ Set the isolation group that will be used when deploying the verticle(s) +++ |[[maxWorkerExecuteTime]]`@maxWorkerExecuteTime`|`Number (long)`|+++ Sets the value of max worker execute time, in link. <p> The default value of link is +++ |[[maxWorkerExecuteTimeUnit]]`@maxWorkerExecuteTimeUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the time unit of <code>maxWorkerExecuteTime</code> +++ |[[multiThreaded]]`@multiThreaded`|`Boolean`|+++ Set whether the verticle(s) should be deployed as a multi-threaded worker verticle. <p> <strong>WARNING</strong>: Multi-threaded worker verticles are a deprecated feature. <p> Most applications will have no need for them. Because of the concurrency in these verticles you have to be very careful to keep the verticle in a consistent state using standard Java techniques for multi-threaded programming. <p> You can read the documentation that explains how you can replace this feature by the usage of custom worker pools or <code>executeBlocking</code> calls. +++ |[[worker]]`@worker`|`Boolean`|+++ Set whether the verticle(s) should be deployed as a worker verticle +++ |[[workerPoolName]]`@workerPoolName`|`String`|+++ Set the worker pool name to use for this verticle. When no name is set, the Vert.x worker pool will be used, when a name is set, the verticle will use a named worker pool. +++ |[[workerPoolSize]]`@workerPoolSize`|`Number (int)`|+++ Set the maximum number of worker threads to be used by the Vert.x instance. +++ |=== [[DnsClientOptions]] == DnsClientOptions ++++ Configuration options for Vert.x DNS client. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[host]]`@host`|`String`|+++ Set the host name to be used by this client in requests. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[port]]`@port`|`Number (int)`|+++ Set the port to be used by this client in requests. +++ |[[queryTimeout]]`@queryTimeout`|`Number (long)`|+++ Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed. +++ |[[recursionDesired]]`@recursionDesired`|`Boolean`|+++ Set whether or not recursion is desired +++ |=== [[DropwizardMetricsOptions]] == DropwizardMetricsOptions ++++ Vert.x Dropwizard metrics configuration. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[baseName]]`@baseName`|`String`|+++ Set a custom baseName for metrics. +++ |[[configPath]]`@configPath`|`String`|+++ Set the path for a config file that contains options in JSON format, to be used to create a new options object. The file will be looked for on the file system first and then on the classpath if it's not found. +++ |[[enabled]]`@enabled`|`Boolean`|+++ Set whether metrics will be enabled on the Vert.x instance. +++ |[[jmxDomain]]`@jmxDomain`|`String`|+++ Set the JMX domain to use when JMX metrics are enabled. +++ |[[jmxEnabled]]`@jmxEnabled`|`Boolean`|+++ Set whether JMX will be enabled on the Vert.x instance. +++ |[[monitoredEventBusHandlers]]`@monitoredEventBusHandlers`|`Array of link:dataobjects.html#Match[Match]`|+++ Add a monitored event bus handler. +++ |[[monitoredHttpClientEndpoint]]`@monitoredHttpClientEndpoint`|`Array of link:dataobjects.html#Match[Match]`|+++ +++ |[[monitoredHttpClientEndpoints]]`@monitoredHttpClientEndpoints`|`Array of link:dataobjects.html#Match[Match]`|+++ Add an monitored http client endpoint. +++ |[[monitoredHttpClientUris]]`@monitoredHttpClientUris`|`Array of link:dataobjects.html#Match[Match]`|+++ Add an monitored http client uri. +++ |[[monitoredHttpServerUris]]`@monitoredHttpServerUris`|`Array of link:dataobjects.html#Match[Match]`|+++ Add an monitored http server uri. +++ |[[registryName]]`@registryName`|`String`|+++ Set the name used for registering the metrics in the Dropwizard shared registry. +++ |=== [[Event]] == Event ++++ Holds properties of Consul event ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[id]]`@id`|`String`|+++ Set ID of event +++ |[[lTime]]`@lTime`|`Number (int)`|+++ Set the Lamport clock time +++ |[[name]]`@name`|`String`|+++ Set name of event +++ |[[node]]`@node`|`String`|+++ Set regular expression to filter by node name +++ |[[payload]]`@payload`|`String`|+++ Set payload of event +++ |[[service]]`@service`|`String`|+++ Set regular expression to filter by service +++ |[[tag]]`@tag`|`String`|+++ Set regular expression to filter by tag +++ |[[version]]`@version`|`Number (int)`|+++ Set version +++ |=== [[EventBusOptions]] == EventBusOptions ++++ Options to configure the event bus. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|+++ Set the accept back log. +++ |[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|+++ Set whether client auth is required +++ |[[clusterPingInterval]]`@clusterPingInterval`|`Number (long)`|+++ Set the value of cluster ping interval, in ms. +++ |[[clusterPingReplyInterval]]`@clusterPingReplyInterval`|`Number (long)`|+++ Set the value of cluster ping reply interval, in ms. +++ |[[clusterPublicHost]]`@clusterPublicHost`|`String`|+++ Set the public facing hostname to be used for clustering. Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. If this is the case you can specify a public hostname which is different from the hostname the server listens at. <p> The default value is null which means use the same as the cluster hostname. +++ |[[clusterPublicPort]]`@clusterPublicPort`|`Number (int)`|+++ See link for an explanation. +++ |[[clustered]]`@clustered`|`Boolean`|+++ Sets whether or not the event bus is clustered. +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Sets the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[host]]`@host`|`String`|+++ Sets the host. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Sets the port. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Sets the value of reconnect attempts. +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval. +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted. +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |=== [[EventList]] == EventList ++++ Holds result of events query ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set Consul index, a unique identifier representing the current state of the requested events +++ |[[list]]`@list`|`Array of link:dataobjects.html#Event[Event]`|+++ Set list of events +++ |=== [[EventListOptions]] == EventListOptions ++++ Holds options for events list request ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[blockingOptions]]`@blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|+++ Set options for blocking query +++ |[[name]]`@name`|`String`|+++ Set event name for filtering on events +++ |=== [[EventOptions]] == EventOptions ++++ Options used to trigger a new user event. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[node]]`@node`|`String`|+++ Set regular expression to filter by node name +++ |[[payload]]`@payload`|`String`|+++ Set payload of event +++ |[[service]]`@service`|`String`|+++ Set regular expression to filter by service +++ |[[tag]]`@tag`|`String`|+++ Set regular expression to filter by tag +++ |=== [[FileSystemOptions]] == FileSystemOptions ++++ Vert.x file system base configuration, this class can be extended by provider implementations to configure those specific implementations. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[classPathResolvingEnabled]]`@classPathResolvingEnabled`|`Boolean`|+++ When vert.x cannot find the file on the filesystem it tries to resolve the file from the class path when this is set to <code>true</code>. +++ |[[fileCacheDir]]`@fileCacheDir`|`String`|+++ When vert.x reads a file that is packaged with the application it gets extracted to this directory first and subsequent reads will use the extracted file to get better IO performance. +++ |[[fileCachingEnabled]]`@fileCachingEnabled`|`Boolean`|+++ Set to <code>true</code> to cache files on the real file system when the filesystem performs class path resolving. +++ |=== [[FindOptions]] == FindOptions ++++ Options used to configure find operations. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[batchSize]]`@batchSize`|`Number (int)`|+++ Set the batch size for methods loading found data in batches. +++ |[[fields]]`@fields`|`Json object`|+++ Set the fields +++ |[[limit]]`@limit`|`Number (int)`|+++ Set the limit +++ |[[skip]]`@skip`|`Number (int)`|+++ Set the skip +++ |[[sort]]`@sort`|`Json object`|+++ Set the sort document +++ |=== [[Frame]] == Frame ++++ Represents a STOMP frame. STOMP frames are structured as follows. It starts by a <code>command</code>, followed by a set of headers. Then the frame may have a body and is finished by a <code>0</code> byte. This class represents this structure and provide access to the different parts. <p/> This class is <strong>NOT</strong> thread-safe. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[ack]]`@ack`|`String`|+++ Gets the value of the <code>ack</code> header. +++ |[[body]]`@body`|`Buffer`|+++ Sets the body of the frame. +++ |[[bodyAsString]]`@bodyAsString`|`String`|+++ Gets the body of the frames as a String encoded in the frame encoding. +++ |[[command]]`@command`|`link:enums.html#Command[Command]`|+++ Sets the frame command. +++ |[[destination]]`@destination`|`String`|- |[[headers]]`@headers`|`String`|+++ Sets the headers of the frames. +++ |[[id]]`@id`|`String`|- |[[receipt]]`@receipt`|`String`|- |[[transaction]]`@transaction`|`String`|- |=== [[GeoMember]] == GeoMember ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[latitude]]`@latitude`|`Number (Double)`|+++ Set Latitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001 +++ |[[longitude]]`@longitude`|`Number (Double)`|+++ Set Longitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001 +++ |[[member]]`@member`|`String`|+++ Set the member name. +++ |=== [[GeoRadiusOptions]] == GeoRadiusOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[count]]`@count`|`Number (Long)`|+++ Set the radius options limit the result count. +++ |[[withCoord]]`@withCoord`|`Boolean`|+++ Set the radius options to be coordinate based. +++ |[[withDist]]`@withDist`|`Boolean`|+++ Set the radius options to be distance based. +++ |[[withHash]]`@withHash`|`Boolean`|+++ Set the radius options to be hash based. +++ |=== [[GoAway]] == GoAway ++++ A frame. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[debugData]]`@debugData`|`Buffer`|+++ Set the additional debug data +++ |[[errorCode]]`@errorCode`|`Number (long)`|+++ +++ |[[lastStreamId]]`@lastStreamId`|`Number (int)`|+++ Set the last stream id. +++ |=== [[GraphQLHandlerOptions]] == GraphQLHandlerOptions ++++ Options for configuring the link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[requestBatchingEnabled]]`@requestBatchingEnabled`|`Boolean`|+++ Whether request batching should be enabled. Defaults to <code>false</code>. +++ |=== [[GraphiQLHandlerOptions]] == GraphiQLHandlerOptions ++++ Embedded GraphiQL user interface options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[enabled]]`@enabled`|`Boolean`|+++ Whether the GraphiQL development tool should be enabled. Defaults to <code>false</code>. +++ |[[graphQLUri]]`@graphQLUri`|`String`|+++ Set the GraphQL endpoint URI. Defaults to the path used to get the GraphiQL user interface. +++ |[[headers]]`@headers`|`String`|+++ A fixed set of HTTP headers to add to GraphiQL requests. Defaults to <code>null</code>. +++ |[[query]]`@query`|`String`|+++ Initial value of the query area in the GraphiQL user interface. Defaults to <code>null</code>. +++ |[[variables]]`@variables`|`Json object`|+++ Initial value of the variables area in the GraphiQL user interface. Defaults to <code>null</code>. +++ |=== [[HtpasswdAuthOptions]] == HtpasswdAuthOptions ++++ Options configuring htpasswd authentication. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[htpasswdFile]]`@htpasswdFile`|`String`|- |[[plainTextEnabled]]`@plainTextEnabled`|`Boolean`|- |=== [[Http2PushMapping]] == Http2PushMapping [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[extensionTarget]]`@extensionTarget`|`String`|- |[[filePath]]`@filePath`|`String`|- |[[noPush]]`@noPush`|`Boolean`|- |=== [[Http2Settings]] == Http2Settings ++++ HTTP2 settings, the settings is initialized with the default HTTP/2 values.<p> The settings expose the parameters defined by the HTTP/2 specification, as well as extra settings for protocol extensions. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[headerTableSize]]`@headerTableSize`|`Number (long)`|+++ Set HTTP/2 setting. +++ |[[initialWindowSize]]`@initialWindowSize`|`Number (int)`|+++ Set the HTTP/2 setting +++ |[[maxConcurrentStreams]]`@maxConcurrentStreams`|`Number (long)`|+++ Set the HTTP/2 setting +++ |[[maxFrameSize]]`@maxFrameSize`|`Number (int)`|+++ Set the HTTP/2 setting +++ |[[maxHeaderListSize]]`@maxHeaderListSize`|`Number (long)`|+++ Set the HTTP/2 setting +++ |[[pushEnabled]]`@pushEnabled`|`Boolean`|+++ Set the HTTP/2 setting +++ |=== [[HttpClientOptions]] == HttpClientOptions ++++ Options describing how an link will make connections. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|+++ 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 link: <ul> <li>: [ "h2", "http/1.1" ]</li> <li>otherwise: [link]</li> </ul> +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|+++ set to <code>initialBufferSizeHttpDecoder</code> the initial buffer of the HttpDecoder. +++ |[[defaultHost]]`@defaultHost`|`String`|+++ Set the default host name to be used by this client in requests if none is provided when making the request. +++ |[[defaultPort]]`@defaultPort`|`Number (int)`|+++ Set the default port to be used by this client in requests if none is provided when making the request. +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[forceSni]]`@forceSni`|`Boolean`|+++ By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to <code>true</code> forces the server name to be always sent. +++ |[[http2ClearTextUpgrade]]`@http2ClearTextUpgrade`|`Boolean`|+++ Set to <code>true</code> when an <i>h2c</i> connection is established using an HTTP/1.1 upgrade request, and <code>false</code> when an <i>h2c</i> connection is established directly (with prior knowledge). +++ |[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|+++ Set the default HTTP/2 connection window size. It overrides the initial window size set by link, so the connection window size is greater than for its streams, in order the data throughput. <p/> A value of <code>-1</code> reuses the initial window size setting. +++ |[[http2KeepAliveTimeout]]`@http2KeepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/2 connections, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[http2MaxPoolSize]]`@http2MaxPoolSize`|`Number (int)`|+++ Set the maximum pool size for HTTP/2 connections +++ |[[http2MultiplexingLimit]]`@http2MultiplexingLimit`|`Number (int)`|+++ 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. <p/> Setting the value to <code>-1</code> means to use the value sent by the server's initial settings. <code>-1</code> is the default value. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|+++ Set the HTTP/2 connection settings immediately sent by to the server when the client connects. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keepAlive]]`@keepAlive`|`Boolean`|+++ Set whether keep alive is enabled on the client +++ |[[keepAliveTimeout]]`@keepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/1.x, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|+++ Set the maximum HTTP chunk size +++ |[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|+++ Set the maximum length of all headers for HTTP/1.x . +++ |[[maxInitialLineLength]]`@maxInitialLineLength`|`Number (int)`|+++ Set the maximum length of the initial line for HTTP/1.x (e.g. <code>"HTTP/1.1 200 OK"</code>) +++ |[[maxPoolSize]]`@maxPoolSize`|`Number (int)`|+++ Set the maximum pool size for connections +++ |[[maxRedirects]]`@maxRedirects`|`Number (int)`|+++ Set to <code>maxRedirects</code> the maximum number of redirection a request can follow. +++ |[[maxWaitQueueSize]]`@maxWaitQueueSize`|`Number (int)`|+++ 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. +++ |[[maxWebSocketFrameSize]]`@maxWebSocketFrameSize`|`Number (int)`|+++ Set the max WebSocket frame size +++ |[[maxWebSocketMessageSize]]`@maxWebSocketMessageSize`|`Number (int)`|+++ Set the max WebSocket message size +++ |[[maxWebsocketFrameSize]]`@maxWebsocketFrameSize`|`Number (int)`|+++ Set the max WebSocket frame size +++ |[[maxWebsocketMessageSize]]`@maxWebsocketMessageSize`|`Number (int)`|+++ Set the max WebSocket message size +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[pipelining]]`@pipelining`|`Boolean`|+++ Set whether pipe-lining is enabled on the client +++ |[[pipeliningLimit]]`@pipeliningLimit`|`Number (int)`|+++ Set the limit of pending requests a pipe-lined HTTP/1 connection can send. +++ |[[poolCleanerPeriod]]`@poolCleanerPeriod`|`Number (int)`|+++ 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. +++ |[[protocolVersion]]`@protocolVersion`|`link:enums.html#HttpVersion[HttpVersion]`|+++ Set the protocol version. +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sendUnmaskedFrames]]`@sendUnmaskedFrames`|`Boolean`|+++ Set <code>true</code> when the client wants to skip frame masking. <p> You may want to set it <code>true</code> on server by server WebSocket communication: in this case you are by passing RFC6455 protocol. <p> It's <code>false</code> as default. +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[tryUseCompression]]`@tryUseCompression`|`Boolean`|+++ Set whether compression is enabled +++ |[[tryUsePerFrameWebSocketCompression]]`@tryUsePerFrameWebSocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-frame deflate compression extension. +++ |[[tryUsePerFrameWebsocketCompression]]`@tryUsePerFrameWebsocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-frame deflate compression extension. +++ |[[tryUsePerMessageWebSocketCompression]]`@tryUsePerMessageWebSocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-message deflate compression extension. +++ |[[tryUsePerMessageWebsocketCompression]]`@tryUsePerMessageWebsocketCompression`|`Boolean`|+++ Set whether the client will offer the WebSocket per-message deflate compression extension. +++ |[[tryWebSocketDeflateFrameCompression]]`@tryWebSocketDeflateFrameCompression`|`Boolean`|+++ +++ |[[tryWebsocketDeflateFrameCompression]]`@tryWebsocketDeflateFrameCompression`|`Boolean`|+++ +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[verifyHost]]`@verifyHost`|`Boolean`|+++ Set whether hostname verification is enabled +++ |[[webSocketClosingTimeout]]`@webSocketClosingTimeout`|`Number (int)`|+++ Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame. <p> When a WebSocket is closed, the server should close the TCP connection. This timeout will close the TCP connection on the client when it expires. <p> Set to <code>0L</code> closes the TCP connection immediately after receiving the close frame. <p> Set to a negative value to disable it. +++ |[[webSocketCompressionAllowClientNoContext]]`@webSocketCompressionAllowClientNoContext`|`Boolean`|+++ Set whether the <code>client_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[webSocketCompressionLevel]]`@webSocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket deflate compression level. +++ |[[webSocketCompressionRequestServerNoContext]]`@webSocketCompressionRequestServerNoContext`|`Boolean`|+++ Set whether the <code>server_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[websocketCompressionAllowClientNoContext]]`@websocketCompressionAllowClientNoContext`|`Boolean`|+++ Set whether the <code>client_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |[[websocketCompressionLevel]]`@websocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket deflate compression level. +++ |[[websocketCompressionRequestServerNoContext]]`@websocketCompressionRequestServerNoContext`|`Boolean`|+++ Set whether the <code>server_no_context_takeover</code> parameter of the WebSocket per-message deflate compression extension will be offered. +++ |=== [[HttpLocation]] == HttpLocation ++++ Represents the location of a HTTP endpoint. This object (its json representation) will be used as "location" in a service record. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[endpoint]]`@endpoint`|`String`|+++ Sets the endpoint, which is the URL of the service. The endpoint is automatically computed when you use the other `setX` method. +++ |[[host]]`@host`|`String`|+++ Sets the host. +++ |[[port]]`@port`|`Number (int)`|+++ Sets the port +++ |[[root]]`@root`|`String`|+++ Sets the path of the service (root) +++ |[[ssl]]`@ssl`|`Boolean`|+++ Sets whether or not the HTTP service is using <code>https</code>. +++ |=== [[HttpServerOptions]] == HttpServerOptions ++++ Represents options used by an link instance ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|+++ Set the accept back log +++ |[[acceptUnmaskedFrames]]`@acceptUnmaskedFrames`|`Boolean`|+++ Set <code>true</code> when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting <code>true</code>. It's set to <code>false</code> as default. +++ |[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|+++ Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. +++ |[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|+++ Set whether client auth is required +++ |[[clientAuthRequired]]`@clientAuthRequired`|`Boolean`|+++ Set whether client auth is required +++ |[[compressionLevel]]`@compressionLevel`|`Number (int)`|+++ This method allows to set the compression level to be used in http1.x/2 response bodies when compression support is turned on (@see setCompressionSupported) and the client advertises to support <code>deflate/gzip</code> compression in the <code>Accept-Encoding</code> header default value is : 6 (Netty legacy) The compression level determines how much the data is compressed on a scale from 1 to 9, where '9' is trying to achieve the maximum compression ratio while '1' instead is giving priority to speed instead of compression ratio using some algorithm optimizations and skipping pedantic loops that usually gives just little improvements While one can think that best value is always the maximum compression ratio, there's a trade-off to consider: the most compressed level requires the most computational work to compress/decompress data, e.g. more dictionary lookups and loops. E.g. you have it set fairly high on a high-volume website, you may experience performance degradation and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side while decompressing - setting an higher compression level can result in an overall higher page load time especially nowadays when many clients are handled mobile devices with a low CPU profile. see also: http://www.gzip.org/algorithm.txt +++ |[[compressionSupported]]`@compressionSupported`|`Boolean`|+++ Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|+++ Set the initial buffer size for the HTTP decoder +++ |[[decompressionSupported]]`@decompressionSupported`|`Boolean`|+++ Set whether the server supports decompression +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[handle100ContinueAutomatically]]`@handle100ContinueAutomatically`|`Boolean`|+++ Set whether 100 Continue should be handled automatically +++ |[[host]]`@host`|`String`|+++ Set the host +++ |[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|+++ Set the default HTTP/2 connection window size. It overrides the initial window size set by link, so the connection window size is greater than for its streams, in order the data throughput. <p/> A value of <code>-1</code> reuses the initial window size setting. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|+++ Set the HTTP/2 connection settings immediatly sent by the server when a client connects. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|+++ Set the maximum HTTP chunk size that link will receive +++ |[[maxFormAttributeSize]]`@maxFormAttributeSize`|`Number (int)`|+++ Set the maximum size of a form attribute. Set to <code>-1</code> to allow unlimited length +++ |[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|+++ Set the maximum length of all headers for HTTP/1.x . +++ |[[maxInitialLineLength]]`@maxInitialLineLength`|`Number (int)`|+++ Set the maximum length of the initial line for HTTP/1.x (e.g. <code>"GET / HTTP/1.0"</code>) +++ |[[maxWebSocketFrameSize]]`@maxWebSocketFrameSize`|`Number (int)`|+++ Set the maximum WebSocket frames size +++ |[[maxWebSocketMessageSize]]`@maxWebSocketMessageSize`|`Number (int)`|+++ Set the maximum WebSocket message size +++ |[[maxWebsocketFrameSize]]`@maxWebsocketFrameSize`|`Number (int)`|+++ Set the maximum WebSocket frames size +++ |[[maxWebsocketMessageSize]]`@maxWebsocketMessageSize`|`Number (int)`|+++ Set the maximum WebSocket message size +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[perFrameWebSocketCompressionSupported]]`@perFrameWebSocketCompressionSupported`|`Boolean`|+++ Enable or disable support for the WebSocket per-frame deflate compression extension. +++ |[[perFrameWebsocketCompressionSupported]]`@perFrameWebsocketCompressionSupported`|`Boolean`|+++ Enable or disable support for the WebSocket per-frame deflate compression extension. +++ |[[perMessageWebSocketCompressionSupported]]`@perMessageWebSocketCompressionSupported`|`Boolean`|+++ Enable or disable support for WebSocket per-message deflate compression extension. +++ |[[perMessageWebsocketCompressionSupported]]`@perMessageWebsocketCompressionSupported`|`Boolean`|+++ Enable or disable support for WebSocket per-message deflate compression extension. +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Set the port +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sni]]`@sni`|`Boolean`|+++ Set whether the server supports Server Name Indiciation +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[webSocketAllowServerNoContext]]`@webSocketAllowServerNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>server_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[webSocketClosingTimeout]]`@webSocketClosingTimeout`|`Number (int)`|+++ Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame. <p> When a server closes a WebSocket, it should wait the client close frame to close the TCP connection. This timeout will close the TCP connection on the server when it expires. When the TCP connection is closed receiving the close frame, the link instead of the link will be called. <p> Set to <code>0L</code> closes the TCP connection immediately after sending the close frame. <p> Set to a negative value to disable it. +++ |[[webSocketCompressionLevel]]`@webSocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket compression level. +++ |[[webSocketPreferredClientNoContext]]`@webSocketPreferredClientNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>client_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[webSocketSubProtocols]]`@webSocketSubProtocols`|`Array of String`|+++ Set the WebSocket list of sub-protocol supported by the server. +++ |[[websocketAllowServerNoContext]]`@websocketAllowServerNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>server_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[websocketCompressionLevel]]`@websocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket compression level. +++ |[[websocketPreferredClientNoContext]]`@websocketPreferredClientNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>client_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[websocketSubProtocols]]`@websocketSubProtocols`|`String`|+++ Set the WebSocket sub-protocols supported by the server. +++ |=== [[HttpTermOptions]] == HttpTermOptions ++++ The web term configuration options. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|+++ Set the accept back log +++ |[[acceptUnmaskedFrames]]`@acceptUnmaskedFrames`|`Boolean`|+++ Set <code>true</code> when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting <code>true</code>. It's set to <code>false</code> as default. +++ |[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|+++ Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. +++ |[[authOptions]]`@authOptions`|`link:dataobjects.html#AuthOptions[AuthOptions]`|+++ +++ |[[charset]]`@charset`|`String`|+++ Set the charset used for encoding / decoding text data from/to SockJS +++ |[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|+++ Set whether client auth is required +++ |[[clientAuthRequired]]`@clientAuthRequired`|`Boolean`|+++ Set whether client auth is required +++ |[[compressionLevel]]`@compressionLevel`|`Number (int)`|+++ This method allows to set the compression level to be used in http1.x/2 response bodies when compression support is turned on (@see setCompressionSupported) and the client advertises to support <code>deflate/gzip</code> compression in the <code>Accept-Encoding</code> header default value is : 6 (Netty legacy) The compression level determines how much the data is compressed on a scale from 1 to 9, where '9' is trying to achieve the maximum compression ratio while '1' instead is giving priority to speed instead of compression ratio using some algorithm optimizations and skipping pedantic loops that usually gives just little improvements While one can think that best value is always the maximum compression ratio, there's a trade-off to consider: the most compressed level requires the most computational work to compress/decompress data, e.g. more dictionary lookups and loops. E.g. you have it set fairly high on a high-volume website, you may experience performance degradation and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side while decompressing - setting an higher compression level can result in an overall higher page load time especially nowadays when many clients are handled mobile devices with a low CPU profile. see also: http://www.gzip.org/algorithm.txt +++ |[[compressionSupported]]`@compressionSupported`|`Boolean`|+++ Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|+++ Set the initial buffer size for the HTTP decoder +++ |[[decompressionSupported]]`@decompressionSupported`|`Boolean`|+++ Set whether the server supports decompression +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[handle100ContinueAutomatically]]`@handle100ContinueAutomatically`|`Boolean`|+++ Set whether 100 Continue should be handled automatically +++ |[[host]]`@host`|`String`|+++ Set the host +++ |[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|+++ 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. <p/> A value of <code>-1</code> reuses the initial window size setting. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|+++ Set the HTTP/2 connection settings immediatly sent by the server when a client connects. +++ |[[intputrc]]`@intputrc`|`String`|+++ The path of the <i>inputrc</i> config. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|+++ Set the maximum HTTP chunk size that will receive +++ |[[maxFormAttributeSize]]`@maxFormAttributeSize`|`Number (int)`|+++ Set the maximum size of a form attribute. Set to <code>-1</code> to allow unlimited length +++ |[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|+++ Set the maximum length of all headers for HTTP/1.x . +++ |[[maxInitialLineLength]]`@maxInitialLineLength`|`Number (int)`|+++ Set the maximum length of the initial line for HTTP/1.x (e.g. <code>"GET / HTTP/1.0"</code>) +++ |[[maxWebSocketFrameSize]]`@maxWebSocketFrameSize`|`Number (int)`|+++ Set the maximum WebSocket frames size +++ |[[maxWebSocketMessageSize]]`@maxWebSocketMessageSize`|`Number (int)`|+++ Set the maximum WebSocket message size +++ |[[maxWebsocketFrameSize]]`@maxWebsocketFrameSize`|`Number (int)`|+++ Set the maximum WebSocket frames size +++ |[[maxWebsocketMessageSize]]`@maxWebsocketMessageSize`|`Number (int)`|+++ Set the maximum WebSocket message size +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[perFrameWebSocketCompressionSupported]]`@perFrameWebSocketCompressionSupported`|`Boolean`|+++ Enable or disable support for the WebSocket per-frame deflate compression extension. +++ |[[perFrameWebsocketCompressionSupported]]`@perFrameWebsocketCompressionSupported`|`Boolean`|+++ Enable or disable support for the WebSocket per-frame deflate compression extension. +++ |[[perMessageWebSocketCompressionSupported]]`@perMessageWebSocketCompressionSupported`|`Boolean`|+++ Enable or disable support for WebSocket per-message deflate compression extension. +++ |[[perMessageWebsocketCompressionSupported]]`@perMessageWebsocketCompressionSupported`|`Boolean`|+++ Enable or disable support for WebSocket per-message deflate compression extension. +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Set the port +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[shellHtmlResource]]`@shellHtmlResource`|`Buffer`|+++ Set <code>shell.html</code> resource to use. +++ |[[sni]]`@sni`|`Boolean`|+++ Set whether the server supports Server Name Indiciation +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[sockJSHandlerOptions]]`@sockJSHandlerOptions`|`link:dataobjects.html#SockJSHandlerOptions[SockJSHandlerOptions]`|+++ The SockJS handler options. +++ |[[sockJSPath]]`@sockJSPath`|`String`|+++ Configure the SockJS path, the default value is <code>/term/*</code>. +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[termJsResource]]`@termJsResource`|`Buffer`|+++ Set <code>term.js</code> resource to use. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[vertsShellJsResource]]`@vertsShellJsResource`|`Buffer`|+++ Set <code>vertxshell.js</code> resource to use. +++ |[[webSocketAllowServerNoContext]]`@webSocketAllowServerNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>server_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[webSocketClosingTimeout]]`@webSocketClosingTimeout`|`Number (int)`|+++ Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame. <p> When a server closes a WebSocket, it should wait the client close frame to close the TCP connection. This timeout will close the TCP connection on the server when it expires. When the TCP connection is closed receiving the close frame, the instead of the will be called. <p> Set to <code>0L</code> closes the TCP connection immediately after sending the close frame. <p> Set to a negative value to disable it. +++ |[[webSocketCompressionLevel]]`@webSocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket compression level. +++ |[[webSocketPreferredClientNoContext]]`@webSocketPreferredClientNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>client_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[webSocketSubProtocols]]`@webSocketSubProtocols`|`Array of String`|+++ Set the WebSocket list of sub-protocol supported by the server. +++ |[[websocketAllowServerNoContext]]`@websocketAllowServerNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>server_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[websocketCompressionLevel]]`@websocketCompressionLevel`|`Number (int)`|+++ Set the WebSocket compression level. +++ |[[websocketPreferredClientNoContext]]`@websocketPreferredClientNoContext`|`Boolean`|+++ Set whether the WebSocket server will accept the <code>client_no_context_takeover</code> parameter of the per-message deflate compression extension offered by the client. +++ |[[websocketSubProtocols]]`@websocketSubProtocols`|`String`|+++ Set the WebSocket sub-protocols supported by the server. +++ |=== [[IndexOptions]] == IndexOptions ++++ Options used to configure index. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[background]]`@background`|`Boolean`|+++ Create the index in the background +++ |[[bits]]`@bits`|`Number (Integer)`|+++ Gets the number of precision of the stored geohash value of the location data in 2d indexes. +++ |[[bucketSize]]`@bucketSize`|`Number (Double)`|+++ Gets the specified the number of units within which to group the location values for geoHaystack Indexes +++ |[[defaultLanguage]]`@defaultLanguage`|`String`|+++ Gets the language for a text index. <p>The language that determines the list of stop words and the rules for the stemmer and tokenizer.</p> +++ |[[languageOverride]]`@languageOverride`|`String`|+++ Gets the name of the field that contains the language string. <p>For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.</p> +++ |[[max]]`@max`|`Number (Double)`|+++ Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes.. +++ |[[min]]`@min`|`Number (Double)`|+++ Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes.. +++ |[[name]]`@name`|`String`|+++ Gets the name of the index. +++ |[[partialFilterExpression]]`@partialFilterExpression`|`Json object`|+++ Get the filter expression for the documents to be included in the index or null if not set +++ |[[sparse]]`@sparse`|`Boolean`|+++ If true, the index only references documents with the specified field +++ |[[sphereVersion]]`@sphereVersion`|`Number (Integer)`|+++ Gets the 2dsphere index version number. +++ |[[storageEngine]]`@storageEngine`|`Json object`|+++ Gets the storage engine options document for this index. +++ |[[textVersion]]`@textVersion`|`Number (Integer)`|+++ The text index version number. +++ |[[unique]]`@unique`|`Boolean`|+++ Gets if the index should be unique. +++ |[[version]]`@version`|`Number (Integer)`|+++ Gets the index version number. +++ |[[weights]]`@weights`|`Json object`|+++ Gets the weighting object for use with a text index <p>A document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score.</p> +++ |=== [[Interval]] == Interval ++++ Postgres Interval is date and time based such as 120 years 3 months 332 days 20 hours 20 minutes 20.999999 seconds ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[days]]`@days`|`Number (int)`|- |[[hours]]`@hours`|`Number (int)`|- |[[microseconds]]`@microseconds`|`Number (int)`|- |[[minutes]]`@minutes`|`Number (int)`|- |[[months]]`@months`|`Number (int)`|- |[[seconds]]`@seconds`|`Number (int)`|- |[[years]]`@years`|`Number (int)`|- |=== [[JDBCAuthOptions]] == JDBCAuthOptions ++++ Options configuring JDBC authentication. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[authenticationQuery]]`@authenticationQuery`|`String`|+++ Set the authentication query to use. Use this if you want to override the default authentication query. +++ |[[config]]`@config`|`Json object`|+++ The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration. +++ |[[datasourceName]]`@datasourceName`|`String`|+++ Set the data source name to use, only use in shared mode. +++ |[[permissionsQuery]]`@permissionsQuery`|`String`|+++ Set the permissions query to use. Use this if you want to override the default permissions query. +++ |[[rolesPrefix]]`@rolesPrefix`|`String`|+++ Set the role prefix to distinguish from permissions when checking for isPermitted requests. +++ |[[rolesQuery]]`@rolesQuery`|`String`|+++ Set the roles query to use. Use this if you want to override the default roles query. +++ |[[shared]]`@shared`|`Boolean`|+++ Set whether the JDBC client is shared or non shared. +++ |=== [[JWTAuthOptions]] == JWTAuthOptions ++++ Options describing how an JWT Auth should behave. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[jwks]]`@jwks`|`Array of Json object`|- |[[jwtOptions]]`@jwtOptions`|`link:dataobjects.html#JWTOptions[JWTOptions]`|- |[[keyStore]]`@keyStore`|`link:dataobjects.html#KeyStoreOptions[KeyStoreOptions]`|- |[[permissionsClaimKey]]`@permissionsClaimKey`|`String`|- |[[pubSecKeys]]`@pubSecKeys`|`Array of link:dataobjects.html#PubSecKeyOptions[PubSecKeyOptions]`|- |[[secrets]]`@secrets`|`Array of link:dataobjects.html#SecretOptions[SecretOptions]`|- |=== [[JWTKeyStoreOptions]] == JWTKeyStoreOptions ++++ Options describing how an JWT KeyStore should behave. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[password]]`@password`|`String`|- |[[path]]`@path`|`String`|- |[[type]]`@type`|`String`|- |=== [[JWTOptions]] == JWTOptions ++++ Options related to creation of new tokens. If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload. Generated JWTs will include an iat claim by default unless noTimestamp is specified. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[algorithm]]`@algorithm`|`String`|- |[[audience]]`@audience`|`Array of String`|- |[[audiences]]`@audiences`|`Array of String`|- |[[expiresInMinutes]]`@expiresInMinutes`|`Number (int)`|- |[[expiresInSeconds]]`@expiresInSeconds`|`Number (int)`|- |[[header]]`@header`|`Json object`|- |[[ignoreExpiration]]`@ignoreExpiration`|`Boolean`|- |[[issuer]]`@issuer`|`String`|- |[[leeway]]`@leeway`|`Number (int)`|- |[[noTimestamp]]`@noTimestamp`|`Boolean`|- |[[permissions]]`@permissions`|`Array of String`|+++ The permissions of this token. +++ |[[subject]]`@subject`|`String`|- |=== [[JWTOptions]] == JWTOptions ++++ Options related to creation of new tokens. If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload. Generated JWTs will include an iat claim by default unless noTimestamp is specified. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[algorithm]]`@algorithm`|`String`|- |[[audience]]`@audience`|`Array of String`|- |[[audiences]]`@audiences`|`Array of String`|- |[[expiresInMinutes]]`@expiresInMinutes`|`Number (int)`|- |[[expiresInSeconds]]`@expiresInSeconds`|`Number (int)`|- |[[header]]`@header`|`Json object`|- |[[ignoreExpiration]]`@ignoreExpiration`|`Boolean`|- |[[issuer]]`@issuer`|`String`|- |[[leeway]]`@leeway`|`Number (int)`|- |[[noTimestamp]]`@noTimestamp`|`Boolean`|- |[[permissions]]`@permissions`|`Array of String`|+++ The permissions of this token. +++ |[[subject]]`@subject`|`String`|- |=== [[JWTOptions]] == JWTOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[algorithm]]`@algorithm`|`String`|- |[[audience]]`@audience`|`Array of String`|- |[[audiences]]`@audiences`|`Array of String`|- |[[expiresInMinutes]]`@expiresInMinutes`|`Number (int)`|- |[[expiresInSeconds]]`@expiresInSeconds`|`Number (int)`|- |[[header]]`@header`|`Json object`|- |[[ignoreExpiration]]`@ignoreExpiration`|`Boolean`|- |[[issuer]]`@issuer`|`String`|- |[[leeway]]`@leeway`|`Number (int)`|- |[[noTimestamp]]`@noTimestamp`|`Boolean`|- |[[permissions]]`@permissions`|`Array of String`|+++ The permissions of this token. +++ |[[subject]]`@subject`|`String`|- |=== [[JdkSSLEngineOptions]] == JdkSSLEngineOptions ++++ Configures a link to use the JDK ssl engine implementation. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |=== [[JksOptions]] == JksOptions ++++ Key or trust store options configuring private key and/or certificates based on Java Keystore files. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[password]]`@password`|`String`|+++ Set the password for the key store +++ |[[path]]`@path`|`String`|+++ Set the path to the key store +++ |[[value]]`@value`|`Buffer`|+++ Set the key store as a buffer +++ |=== [[KeyStoreOptions]] == KeyStoreOptions ++++ Options describing how an JWT KeyStore should behave. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[password]]`@password`|`String`|- |[[path]]`@path`|`String`|- |[[type]]`@type`|`String`|- |=== [[KeyStoreOptions]] == KeyStoreOptions ++++ Key or trust store options configuring private key and/or certificates based on <code>KeyStore</code>. <ul> <li>when used as a key store, it should point to a store containing a private key and its certificate.</li> <li>when used as a trust store, it should point to a store containing a list of trusted certificates.</li> </ul> <p> The store can either be loaded by Vert.x from the filesystem: <pre> HttpServerOptions options = HttpServerOptions.httpServerOptions(); options.setKeyCertOptions(new KeyStoreOptions().setType("JKS").setPath("/mykeystore.jks").setPassword("foo")); </pre> Or directly provided as a buffer: <pre> Buffer store = vertx.fileSystem().readFileBlocking("/mykeystore.jks"); options.setKeyCertOptions(new KeyStoreOptions().setType("JKS").setValue(store).setPassword("foo")); </pre> <p> You can also use specific subclasses link or link that will set the link for you: <pre> HttpServerOptions options = HttpServerOptions.httpServerOptions(); options.setKeyCertOptions(new JksOptions().setPath("/mykeystore.jks").setPassword("foo")); </pre> ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[password]]`@password`|`String`|+++ Set the password for the key store +++ |[[path]]`@path`|`String`|+++ Set the path to the key store +++ |[[provider]]`@provider`|`String`|+++ Set the store provider. +++ |[[type]]`@type`|`String`|+++ Set the store type. +++ |[[value]]`@value`|`Buffer`|+++ Set the key store as a buffer +++ |=== [[KeyValue]] == KeyValue ++++ Represents key/value pair stored in Consul ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[createIndex]]`@createIndex`|`Number (long)`|+++ Set the internal index value that represents when the entry was created. +++ |[[flags]]`@flags`|`Number (long)`|+++ Set the flags attached to this entry. Clients can choose to use this however makes sense for their application. +++ |[[key]]`@key`|`String`|+++ Set the key +++ |[[lockIndex]]`@lockIndex`|`Number (long)`|+++ Set the number of times this key has successfully been acquired in a lock. +++ |[[modifyIndex]]`@modifyIndex`|`Number (long)`|+++ Set the last index that modified this key. +++ |[[session]]`@session`|`String`|+++ Set the session that owns the lock +++ |[[value]]`@value`|`String`|+++ Set the value +++ |=== [[KeyValueList]] == KeyValueList ++++ Holds result of key/value pairs query ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set Consul index +++ |[[list]]`@list`|`Array of link:dataobjects.html#KeyValue[KeyValue]`|+++ Set list of key/value pairs +++ |=== [[KeyValueOptions]] == KeyValueOptions ++++ Options used to put key/value pair to Consul. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acquireSession]]`@acquireSession`|`String`|+++ Set session ID for lock acquisition operation. +++ |[[casIndex]]`@casIndex`|`Number (long)`|+++ Set the Check-And-Set index. If the index is <code>0</code>, Consul will only put the key if it does not already exist. If the index is non-zero, the key is only set if the index matches the ModifyIndex of that key. +++ |[[flags]]`@flags`|`Number (long)`|+++ Set the flags. Flags is an value between <code>0</code> and 2<sup>64</sup>-1 that can be attached to each entry. Clients can choose to use this however makes sense for their application. +++ |[[releaseSession]]`@releaseSession`|`String`|+++ Set session ID for lock release operation. +++ |=== [[KillFilter]] == KillFilter ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[addr]]`@addr`|`String`|+++ Set ADDR filter +++ |[[id]]`@id`|`String`|+++ Set ID filter +++ |[[skipme]]`@skipme`|`Boolean`|+++ Set SKIPME filter +++ |[[type]]`@type`|`link:enums.html#Type[Type]`|+++ Set TYPE filter +++ |=== [[LimitOptions]] == LimitOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[count]]`@count`|`Number (Long)`|- |[[offset]]`@offset`|`Number (Long)`|- |=== [[Line]] == Line ++++ Line data type in Postgres represented by the linear equation Ax + By + C = 0, where A and B are not both zero. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[a]]`@a`|`Number (double)`|- |[[b]]`@b`|`Number (double)`|- |[[c]]`@c`|`Number (double)`|- |=== [[LineSegment]] == LineSegment ++++ Finite line segment data type in Postgres represented by pairs of links that are the endpoints of the segment. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[p1]]`@p1`|`link:dataobjects.html#Point[Point]`|- |[[p2]]`@p2`|`link:dataobjects.html#Point[Point]`|- |=== [[ListConsumerGroupOffsetsOptions]] == ListConsumerGroupOffsetsOptions [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |=== [[ListOffsetsResultInfo]] == ListOffsetsResultInfo [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[offset]]`@offset`|`Number (long)`|+++ Set the offset +++ |[[timestamp]]`@timestamp`|`Number (long)`|+++ Set the timestamp +++ |=== [[MailAttachment]] == MailAttachment ++++ Represent a mail attachment that can be used in a MailMessage. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[contentId]]`@contentId`|`String`|+++ set the Content-ID field to be used in the attachment +++ |[[contentType]]`@contentType`|`String`|+++ set the Content-Type +++ |[[data]]`@data`|`Buffer`|+++ set the data +++ |[[description]]`@description`|`String`|+++ set the description field to be used in the attachment +++ |[[disposition]]`@disposition`|`String`|+++ set the disposition field to be used in the attachment +++ |[[headers]]`@headers`|`String`|+++ Add an header to this attachment. +++ |[[name]]`@name`|`String`|+++ set the name +++ |=== [[MailConfig]] == MailConfig ++++ represents the configuration of a mail service with mail server hostname, port, security options, login options and login/password ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[allowRcptErrors]]`@allowRcptErrors`|`Boolean`|+++ set if sending allows rcpt errors <p> if true, the mail will be sent to the recipients that the server accepted, if any <p> +++ |[[authMethods]]`@authMethods`|`String`|+++ set string of allowed auth methods. if set only these methods will be used if the server supports them. If null or empty all supported methods may be used +++ |[[disableEsmtp]]`@disableEsmtp`|`Boolean`|+++ set if ESMTP should be tried as first command (EHLO) <p> rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use old SMTP. If there is a server that does not support EHLO and does not give an error code back, the connection should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a setting. The odds of this actually happening are very small since the client will not connect to arbitrary smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO in that way, the property has to be set to false. <p> +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[hostname]]`@hostname`|`String`|+++ Set the hostname of the smtp server. +++ |[[keepAlive]]`@keepAlive`|`Boolean`|+++ set if connection pool is enabled default is true <p> if the connection pooling is disabled, the max number of sockets is enforced nevertheless <p> +++ |[[keyStore]]`@keyStore`|`String`|+++ get the key store filename to be used when opening SMTP connections <p> if not set, an options object will be created based on other settings (ssl and trustAll) +++ |[[keyStorePassword]]`@keyStorePassword`|`String`|+++ get the key store password to be used when opening SMTP connections +++ |[[login]]`@login`|`link:enums.html#LoginOption[LoginOption]`|+++ Set the login mode for the connection. <p> Either DISABLED, OPTIONAL or REQUIRED +++ |[[maxPoolSize]]`@maxPoolSize`|`Number (int)`|+++ set the max allowed number of open connections to the mail server if not set the default is 10 +++ |[[ownHostname]]`@ownHostname`|`String`|+++ set the hostname to be used for HELO/EHLO and the Message-ID +++ |[[password]]`@password`|`String`|+++ Set the password for the login. +++ |[[port]]`@port`|`Number (int)`|+++ Set the port of the smtp server. +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set the sslOnConnect mode for the connection. +++ |[[starttls]]`@starttls`|`link:enums.html#StartTLSOptions[StartTLSOptions]`|+++ Set the tls security mode for the connection. <p> Either NONE, OPTIONAL or REQUIRED +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation +++ |[[username]]`@username`|`String`|+++ Set the username for the login. +++ |=== [[MailMessage]] == MailMessage ++++ represent a mail message that can be sent via the MailClient ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[attachment]]`@attachment`|`Array of link:dataobjects.html#MailAttachment[MailAttachment]`|+++ set the list of attachments of this mail +++ |[[bcc]]`@bcc`|`Array of String`|+++ set list of bcc addresses +++ |[[bounceAddress]]`@bounceAddress`|`String`|+++ set bounce address of this mail +++ |[[cc]]`@cc`|`Array of String`|+++ set list of cc addresses +++ |[[fixedHeaders]]`@fixedHeaders`|`Boolean`|+++ set whether our own headers should be the only headers added to the message +++ |[[from]]`@from`|`String`|+++ set from address of this mail +++ |[[headers]]`@headers`|`String`|+++ Add a message header. +++ |[[html]]`@html`|`String`|+++ set the html text of this mail +++ |[[inlineAttachment]]`@inlineAttachment`|`Array of link:dataobjects.html#MailAttachment[MailAttachment]`|+++ set the list of inline attachments of this mail +++ |[[subject]]`@subject`|`String`|+++ set the subject of this mail +++ |[[text]]`@text`|`String`|+++ set the plain text of this mail +++ |[[to]]`@to`|`Array of String`|+++ set list of to addresses +++ |=== [[MailResult]] == MailResult ++++ Represent the result of the sendMail operation ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[messageID]]`@messageID`|`String`|+++ +++ |[[recipients]]`@recipients`|`Array of String`|+++ +++ |=== [[MaintenanceOptions]] == MaintenanceOptions ++++ Options used to placing a given service into "maintenance mode". During maintenance mode, the service will be marked as unavailable and will not be present in DNS or API queries. Maintenance mode is persistent and will be automatically restored on agent restart. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[enable]]`@enable`|`Boolean`|+++ Set maintenance mode to enabled: <code>true</code> to enter maintenance mode or <code>false</code> to resume normal operation. This flag is required. +++ |[[id]]`@id`|`String`|+++ Set the ID of service. This field is required. +++ |[[reason]]`@reason`|`String`|+++ Set the reason message. If provided, its value should be a text string explaining the reason for placing the service into maintenance mode. This is simply to aid human operators. +++ |=== [[Match]] == Match ++++ A match for a value. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[alias]]`@alias`|`String`|+++ Set an alias that would replace the label value when it matches. +++ |[[domain]]`@domain`|`link:enums.html#MetricsDomain[MetricsDomain]`|+++ Set the label domain, restricting this rule to a single domain. +++ |[[label]]`@label`|`String`|+++ Set the label name. The match will apply to the values related to this key. +++ |[[type]]`@type`|`link:enums.html#MatchType[MatchType]`|+++ Set the type of matching to apply. +++ |[[value]]`@value`|`String`|+++ Set the matched value. +++ |=== [[Match]] == Match ++++ A match for a value. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[alias]]`@alias`|`String`|+++ Set the alias the human readable name that will be used as a part of registry entry name when the value matches. +++ |[[type]]`@type`|`link:enums.html#MatchType[MatchType]`|+++ Set the type of matching to apply. +++ |[[value]]`@value`|`String`|+++ Set the matched value. +++ |=== [[MemberAssignment]] == MemberAssignment ++++ A description of the assignments of a specific group member ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[topicPartitions]]`@topicPartitions`|`Array of link:dataobjects.html#TopicPartition[TopicPartition]`|+++ Set the list of topic partitions +++ |=== [[MemberDescription]] == MemberDescription ++++ A detailed description of a single group instance in the cluster ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[assignment]]`@assignment`|`link:dataobjects.html#MemberAssignment[MemberAssignment]`|+++ Set the assignment of the group member +++ |[[clientId]]`@clientId`|`String`|+++ Set the client id of the group member +++ |[[consumerId]]`@consumerId`|`String`|+++ Set the consumer id of the group member +++ |[[host]]`@host`|`String`|+++ Set the host where the group member is running +++ |=== [[MetricsOptions]] == MetricsOptions ++++ Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific implementations. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[enabled]]`@enabled`|`Boolean`|+++ Set whether metrics will be enabled on the Vert.x instance. +++ |=== [[MicrometerMetricsOptions]] == MicrometerMetricsOptions ++++ Vert.x micrometer configuration. <p> It is required to set either <code>influxDbOptions</code>, <code>prometheusOptions</code> or <code>jmxMetricsOptions</code> (or, programmatically, <code>micrometerRegistry</code>) in order to actually report metrics. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[disabledMetricsCategories]]`@disabledMetricsCategories`|`Array of link:enums.html#MetricsDomain[MetricsDomain]`|+++ Sets metrics types that are disabled. +++ |[[enabled]]`@enabled`|`Boolean`|+++ Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default. +++ |[[influxDbOptions]]`@influxDbOptions`|`link:dataobjects.html#VertxInfluxDbOptions[VertxInfluxDbOptions]`|+++ Set InfluxDB options. Setting a registry backend option is mandatory in order to effectively report metrics. +++ |[[jmxMetricsOptions]]`@jmxMetricsOptions`|`link:dataobjects.html#VertxJmxMetricsOptions[VertxJmxMetricsOptions]`|+++ Set JMX metrics options. Setting a registry backend option is mandatory in order to effectively report metrics. +++ |[[jvmMetricsEnabled]]`@jvmMetricsEnabled`|`Boolean`|+++ Whether JVM metrics should be collected. Defaults to <code>false</code>. +++ |[[labelMatches]]`@labelMatches`|`Array of link:dataobjects.html#Match[Match]`|+++ Set a list of rules for label matching. +++ |[[labelMatchs]]`@labelMatchs`|`Array of link:dataobjects.html#Match[Match]`|+++ Add a rule for label matching. +++ |[[labels]]`@labels`|`Array of link:enums.html#Label[Label]`|+++ Sets enabled labels. These labels can be fine-tuned later on using Micrometer's Meter filters (see http://micrometer.io/docs/concepts#_meter_filters) +++ |[[prometheusOptions]]`@prometheusOptions`|`link:dataobjects.html#VertxPrometheusOptions[VertxPrometheusOptions]`|+++ Set Prometheus options. Setting a registry backend option is mandatory in order to effectively report metrics. +++ |[[registryName]]`@registryName`|`String`|+++ Set a name for the metrics registry, so that a new registry will be created and associated with this name. If <code>registryName</code> is not provided (or null), a default registry will be used. If the same name is given to several Vert.x instances (within the same JVM), they will share the same registry. +++ |=== [[MigrateOptions]] == MigrateOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[copy]]`@copy`|`Boolean`|- |[[replace]]`@replace`|`Boolean`|- |=== [[MongoAuthOptions]] == MongoAuthOptions ++++ Options configuring Mongo authentication. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[collectionName]]`@collectionName`|`String`|+++ The property name to be used to set the name of the collection inside the config. +++ |[[config]]`@config`|`Json object`|+++ The mongo client configuration: see Mongo Client documentation. +++ |[[datasourceName]]`@datasourceName`|`String`|+++ The mongo data source name: see Mongo Client documentation. +++ |[[passwordField]]`@passwordField`|`String`|+++ The property name to be used to set the name of the field, where the password is stored inside +++ |[[permissionField]]`@permissionField`|`String`|+++ The property name to be used to set the name of the field, where the permissions are stored inside. +++ |[[roleField]]`@roleField`|`String`|+++ The property name to be used to set the name of the field, where the roles are stored inside. +++ |[[saltField]]`@saltField`|`String`|+++ The property name to be used to set the name of the field, where the SALT is stored inside. +++ |[[saltStyle]]`@saltStyle`|`link:enums.html#HashSaltStyle[HashSaltStyle]`|+++ The property name to be used to set the name of the field, where the salt style is stored inside +++ |[[shared]]`@shared`|`Boolean`|+++ Use a shared Mongo client or not. +++ |[[usernameCredentialField]]`@usernameCredentialField`|`String`|+++ The property name to be used to set the name of the field, where the username for the credentials is stored inside. +++ |[[usernameField]]`@usernameField`|`String`|+++ The property name to be used to set the name of the field, where the username is stored inside. +++ |=== [[MongoClientBulkWriteResult]] == MongoClientBulkWriteResult ++++ Result propagated from mongodb driver bulk write result. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[deletedCount]]`@deletedCount`|`Number (long)`|+++ Returns the number of deleted documents +++ |[[insertedCount]]`@insertedCount`|`Number (long)`|+++ Returns the number of inserted documents +++ |[[matchedCount]]`@matchedCount`|`Number (long)`|+++ Returns the number of matched documents +++ |[[modifiedCount]]`@modifiedCount`|`Number (long)`|+++ Returns the number of modified documents +++ |[[upserts]]`@upserts`|`Array of Json object`|+++ An unmodifiable list of upsert data. Each entry has the index of the request that lead to the upsert, and the generated ID of the upsert. +++ |=== [[MongoClientDeleteResult]] == MongoClientDeleteResult ++++ Result propagated from mongodb driver delete result. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[removedCount]]`@removedCount`|`Number (long)`|+++ Get the number of removed documents +++ |=== [[MongoClientUpdateResult]] == MongoClientUpdateResult ++++ Result propagated from mongodb driver update result. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[docMatched]]`@docMatched`|`Number (long)`|+++ Get the number of documents that're matched +++ |[[docModified]]`@docModified`|`Number (long)`|+++ Get the number of documents that're modified +++ |[[docUpsertedId]]`@docUpsertedId`|`Json object`|+++ Get the document id that's upserted +++ |=== [[MqttAuth]] == MqttAuth ++++ MQTT authentication information ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[password]]`@password`|`String`|+++ +++ |[[username]]`@username`|`String`|+++ +++ |=== [[MqttClientOptions]] == MqttClientOptions ++++ Represents options used by the MQTT client. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[ackTimeout]]`@ackTimeout`|`Number (int)`|+++ Sets the time in seconds after which the client will stop waiting for a PUBACK, PUBREC or PUBCOMP packet from the server in response to a packet it has sent. <p> The default value of this property is -1 which indicates that the client should wait an unlimited time for the server's acknowledgement. +++ |[[autoGeneratedClientId]]`@autoGeneratedClientId`|`Boolean`|+++ Set if the MQTT client must generate clientId automatically (default is true) +++ |[[autoKeepAlive]]`@autoKeepAlive`|`Boolean`|+++ Set if the MQTT client must handle PINGREQ automatically (default is true) +++ |[[cleanSession]]`@cleanSession`|`Boolean`|+++ Set to start with a clean session (or not) +++ |[[clientId]]`@clientId`|`String`|+++ Set the client identifier +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Do the same thing as link. Use it instead. +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keepAliveInterval]]`@keepAliveInterval`|`Number (int)`|+++ Set the keep alive interval in seconds +++ |[[keepAliveTimeSeconds]]`@keepAliveTimeSeconds`|`Number (int)`|+++ +++ |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxInflightQueue]]`@maxInflightQueue`|`Number (int)`|+++ Set max count of unacknowledged messages +++ |[[maxMessageSize]]`@maxMessageSize`|`Number (int)`|+++ Set max MQTT message size +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[password]]`@password`|`String`|+++ Set the password +++ |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Set the value of reconnect attempts +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[username]]`@username`|`String`|+++ Set the username +++ |[[willFlag]]`@willFlag`|`Boolean`|+++ Set if will information are provided on connection +++ |[[willMessage]]`@willMessage`|`String`|+++ Set the content of the will message +++ |[[willQoS]]`@willQoS`|`Number (int)`|+++ Set the QoS level for the will message +++ |[[willRetain]]`@willRetain`|`Boolean`|+++ Set if the will message must be retained +++ |[[willTopic]]`@willTopic`|`String`|+++ Set the topic on which the will message will be published +++ |=== [[MqttServerOptions]] == MqttServerOptions ++++ Represents options used by the MQTT server ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|+++ Set the accept back log +++ |[[autoClientId]]`@autoClientId`|`Boolean`|+++ Set if clientid should be auto-generated when it's "zero-bytes" +++ |[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|+++ Set whether client auth is required +++ |[[clientAuthRequired]]`@clientAuthRequired`|`Boolean`|+++ Set whether client auth is required +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[host]]`@host`|`String`|+++ Set the host +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[maxMessageSize]]`@maxMessageSize`|`Number (int)`|+++ Set max MQTT message size +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Set the port +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sni]]`@sni`|`Boolean`|+++ Set whether the server supports Server Name Indiciation +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[timeoutOnConnect]]`@timeoutOnConnect`|`Number (int)`|+++ Set the timeout on CONNECT packet +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |=== [[MqttWill]] == MqttWill ++++ Will information from the remote MQTT client ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[willFlag]]`@willFlag`|`Boolean`|+++ +++ |[[willMessage]]`@willMessage`|`String`|+++ +++ |[[willQos]]`@willQos`|`Number (int)`|+++ +++ |[[willRetain]]`@willRetain`|`Boolean`|+++ +++ |[[willTopic]]`@willTopic`|`String`|+++ +++ |=== [[MySQLAuthOptions]] == MySQLAuthOptions ++++ Authentication options for MySQL authentication which can be used for CHANGE_USER command. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[charset]]`@charset`|`String`|+++ Set the charset for the connection. +++ |[[collation]]`@collation`|`String`|+++ Set the collation for the connection. +++ |[[database]]`@database`|`String`|+++ Specify the default database for the re-authentication. +++ |[[password]]`@password`|`String`|+++ Specify the user password to be used for the authentication. +++ |[[properties]]`@properties`|`String`|+++ Set connection attributes which will be sent to server at the re-authentication. +++ |[[serverRsaPublicKeyPath]]`@serverRsaPublicKeyPath`|`String`|+++ Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. +++ |[[serverRsaPublicKeyValue]]`@serverRsaPublicKeyValue`|`Buffer`|+++ Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. +++ |[[user]]`@user`|`String`|+++ Specify the user account to be used for the authentication. +++ |=== [[MySQLConnectOptions]] == MySQLConnectOptions ++++ Connect options for configuring link or link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[authenticationPlugin]]`@authenticationPlugin`|`link:enums.html#MySQLAuthenticationPlugin[MySQLAuthenticationPlugin]`|+++ Set the default link for the client, the option will take effect at the connection start. +++ |[[cachePreparedStatements]]`@cachePreparedStatements`|`Boolean`|+++ Set whether prepared statements cache should be enabled. +++ |[[characterEncoding]]`@characterEncoding`|`String`|+++ Set the Java charset for encoding string values, this value is UTF-8 by default. +++ |[[charset]]`@charset`|`String`|+++ Set the charset for the connection. +++ |[[collation]]`@collation`|`String`|+++ Set the collation for the connection. +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[database]]`@database`|`String`|+++ Specify the default database for the connection. +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[host]]`@host`|`String`|+++ Specify the host for connecting to the server. +++ |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[password]]`@password`|`String`|+++ Specify the user password to be used for the authentication. +++ |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Specify the port for connecting to the server. +++ |[[preparedStatementCacheMaxSize]]`@preparedStatementCacheMaxSize`|`Number (int)`|+++ Set the maximum number of prepared statements that the connection will cache. +++ |[[preparedStatementCacheSqlLimit]]`@preparedStatementCacheSqlLimit`|`Number (int)`|+++ Set the maximum length of prepared statement SQL string that the connection will cache. <p> This is an helper setting the link. +++ |[[properties]]`@properties`|`String`|+++ Set properties for this client, which will be sent to server at the connection start. +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Set the value of reconnect attempts +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[serverRsaPublicKeyPath]]`@serverRsaPublicKeyPath`|`String`|+++ Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. +++ |[[serverRsaPublicKeyValue]]`@serverRsaPublicKeyValue`|`Buffer`|+++ Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[sslMode]]`@sslMode`|`link:enums.html#SslMode[SslMode]`|+++ Set the link for the client, this option can be used to specify the desired security state of the connection to the server. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAffectedRows]]`@useAffectedRows`|`Boolean`|+++ Sets how affected rows are calculated on update/delete/insert, if set to <code>true</code> an update that effectively does not change any data returns zero affected rows. See <a href="https://dev.mysql.com/doc/refman/8.0/en/mysql-affected-rows.html">mysql-affected-rows</a> for details. +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |[[user]]`@user`|`String`|+++ Specify the user account to be used for the authentication. +++ |=== [[NetClientOptions]] == NetClientOptions ++++ Options for configuring a link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++ Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[metricsName]]`@metricsName`|`String`|+++ Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|+++ Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++ Set the value of reconnect attempts +++ |[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++ Set the reconnect interval +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustAll]]`@trustAll`|`Boolean`|+++ Set whether all server certificates should be trusted +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |=== [[NetServerOptions]] == NetServerOptions ++++ Options for configuring a link. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|+++ Set the accept back log +++ |[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|+++ Set whether client auth is required +++ |[[clientAuthRequired]]`@clientAuthRequired`|`Boolean`|+++ Set whether client auth is required +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[host]]`@host`|`String`|+++ Set the host +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|- |[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++ Set the key/cert store options in pem format. +++ |[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++ Set the trust options in pem format +++ |[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the key/cert options in pfx format. +++ |[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++ Set the trust options in pfx format +++ |[[port]]`@port`|`Number (int)`|+++ Set the port +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[sni]]`@sni`|`Boolean`|+++ Set whether the server supports Server Name Indiciation +++ |[[soLinger]]`@soLinger`|`Number (int)`|+++ Set whether SO_linger keep alive is enabled +++ |[[ssl]]`@ssl`|`Boolean`|+++ Set whether SSL/TLS is enabled +++ |[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|+++ Set the SSL handshake timeout, default time unit is seconds. +++ |[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the SSL handshake timeout unit. If not specified, default is seconds. +++ |[[tcpCork]]`@tcpCork`|`Boolean`|+++ Enable the <code>TCP_CORK</code> option - only with linux native transport. +++ |[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++ Enable the <code>TCP_FASTOPEN</code> option - only with linux native transport. +++ |[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++ Set whether TCP keep alive is enabled +++ |[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++ Set whether TCP no delay is enabled +++ |[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++ Enable the <code>TCP_QUICKACK</code> option - only with linux native transport. +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the trust options in jks format, aka Java truststore +++ |[[useAlpn]]`@useAlpn`|`Boolean`|+++ Set the ALPN usage. +++ |[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++ Set whether Netty pooled buffers are enabled +++ |=== [[NetworkOptions]] == NetworkOptions ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++ Set the TCP receive buffer size +++ |[[reuseAddress]]`@reuseAddress`|`Boolean`|+++ Set the value of reuse address +++ |[[reusePort]]`@reusePort`|`Boolean`|+++ Set the value of reuse port. <p/> This is only supported by native transports. +++ |[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++ Set the TCP send buffer size +++ |[[trafficClass]]`@trafficClass`|`Number (int)`|+++ Set the value of traffic class +++ |=== [[NewTopic]] == NewTopic ++++ A new topic to be created ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[config]]`@config`|`String`|+++ Set the configuration for the new topic or null if no configs ever specified +++ |[[name]]`@name`|`String`|+++ Set the name of the topic to be created +++ |[[numPartitions]]`@numPartitions`|`Number (int)`|+++ Set the number of partitions for the new topic or -1 if a replica assignment has been specified +++ |[[replicationFactor]]`@replicationFactor`|`Number (short)`|+++ Set the replication factor for the new topic or -1 if a replica assignment has been specified +++ |=== [[Node]] == Node ++++ ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[address]]`@address`|`String`|+++ Set node address +++ |[[lanAddress]]`@lanAddress`|`String`|+++ Set node lan address +++ |[[name]]`@name`|`String`|+++ Set node name +++ |[[wanAddress]]`@wanAddress`|`String`|+++ Set node wan address +++ |=== [[Node]] == Node ++++ Information about a Kafka cluster node ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[empty]]`@empty`|`Boolean`|+++ +++ |[[hasRack]]`@hasRack`|`Boolean`|+++ Set if this node has a defined rack +++ |[[host]]`@host`|`String`|+++ Set the host name for this node +++ |[[id]]`@id`|`Number (int)`|+++ Set the node id of this node +++ |[[idString]]`@idString`|`String`|+++ Set the string representation of the node id +++ |[[isEmpty]]`@isEmpty`|`Boolean`|+++ Set if this node is empty +++ |[[port]]`@port`|`Number (int)`|+++ Set the port for this node +++ |[[rack]]`@rack`|`String`|+++ Set the rack for this node +++ |=== [[NodeList]] == NodeList ++++ Holds result of nodes query ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[index]]`@index`|`Number (long)`|+++ Set Consul index, a unique identifier representing the current state of the requested list of nodes +++ |[[list]]`@list`|`Array of link:dataobjects.html#Node[Node]`|+++ Set list of nodes +++ |=== [[NodeQueryOptions]] == NodeQueryOptions ++++ Options used to requesting list of nodes ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[blockingOptions]]`@blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|+++ Set options for blocking query +++ |[[near]]`@near`|`String`|+++ Set node name for sorting the list in ascending order based on the estimated round trip time from that node. +++ |=== [[OAuth2ClientOptions]] == OAuth2ClientOptions ++++ Options describing how an OAuth2 will make connections. ++++ ''' [cols=">25%,25%,50%"] [frame="topbot"] |=== ^|Name | Type ^| Description |[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|+++ 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 link: <ul> <li>: [ "h2", "http/1.1" ]</li> <li>otherwise: [link]</li> </ul> +++ |[[authorizationPath]]`@authorizationPath`|`String`|+++ Get the Oauth2 authorization resource path. e.g.: /oauth/authorize +++ |[[clientID]]`@clientID`|`String`|+++ Set the provider client id +++ |[[clientSecret]]`@clientSecret`|`String`|+++ Set the provider client secret +++ |[[clientSecretParameterName]]`@clientSecretParameterName`|`String`|+++ Override the HTTP form field name for client secret +++ |[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++ Set the connect timeout +++ |[[crlPaths]]`@crlPaths`|`Array of String`|+++ Add a CRL path +++ |[[crlValues]]`@crlValues`|`Array of Buffer`|+++ Add a CRL value +++ |[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|+++ set to <code>initialBufferSizeHttpDecoder</code> the initial buffer of the HttpDecoder. +++ |[[defaultHost]]`@defaultHost`|`String`|+++ Set the default host name to be used by this client in requests if none is provided when making the request. +++ |[[defaultPort]]`@defaultPort`|`Number (int)`|+++ Set the default port to be used by this client in requests if none is provided when making the request. +++ |[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++ Add an enabled cipher suite, appended to the ordered suites. +++ |[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++ Sets the list of enabled SSL/TLS protocols. +++ |[[extraParameters]]`@extraParameters`|`Json object`|+++ Set extra parameters to be sent to the provider on each request +++ |[[flow]]`@flow`|`link:enums.html#OAuth2FlowType[OAuth2FlowType]`|- |[[forceSni]]`@forceSni`|`Boolean`|+++ By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to <code>true</code> forces the server name to be always sent. +++ |[[headers]]`@headers`|`Json object`|+++ Set custom headers to be sent with every request to the provider +++ |[[http2ClearTextUpgrade]]`@http2ClearTextUpgrade`|`Boolean`|+++ Set to <code>true</code> when an <i>h2c</i> connection is established using an HTTP/1.1 upgrade request, and <code>false</code> when an <i>h2c</i> connection is established directly (with prior knowledge). +++ |[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|+++ 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. <p/> A value of <code>-1</code> reuses the initial window size setting. +++ |[[http2KeepAliveTimeout]]`@http2KeepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/2 connections, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[http2MaxPoolSize]]`@http2MaxPoolSize`|`Number (int)`|+++ Set the maximum pool size for HTTP/2 connections +++ |[[http2MultiplexingLimit]]`@http2MultiplexingLimit`|`Number (int)`|+++ 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. <p/> Setting the value to <code>-1</code> means to use the value sent by the server's initial settings. <code>-1</code> is the default value. +++ |[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++ Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use link +++ |[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|+++ Set the idle timeout unit. If not specified, default is seconds. +++ |[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|+++ Set the HTTP/2 connection settings immediately sent by to the server when the client connects. +++ |[[introspectionPath]]`@introspectionPath`|`String`|+++ Set the provider token introspection resource path +++ |[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|- |[[jwkPath]]`@jwkPath`|`String`|- |[[jwtOptions]]`@jwtOptions`|`link:dataobjects.html#JWTOptions[JWTOptions]`|- |[[keepAlive]]`@keepAlive`|`Boolean`|+++ Set whether keep alive is enabled on the client +++ |[[keepAliveTimeout]]`@keepAliveTimeout`|`Number (int)`|+++ Set the keep alive timeout for HTTP/1.x, in seconds. <p/> This value determines how long a connection remains unused in the pool before being evicted and closed. <p/> A timeout of <code>0</code> means there is no timeout and the connection can remain indefinitely in the pool. +++ |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++ Set the key/cert options in jks format, aka Java keystore. +++ |[[localAddress]]`@localAddress`|`String`|+++ 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. +++ |[[logActivity]]`@logActivity`|`Boolean`|+++ Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. +++ |[[logoutPath]]`@logoutPath`|`String`|+++ Set the provider logout path +++ |[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|+++ Set the maximum HTTP chunk size +++ |[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|+++ Set the maximum length of all headers for