AclToken

Holds properties of Acl token

Name

Type

Description

@id

String

Set ID of token

@name

String

Set name of token

@rules

String

Set rules for token

@type

AclTokenType

Set type of token

AddressResolverOptions

Configuration options for Vert.x hostname resolver. The resolver uses the local hosts file and performs DNS A and AAAA queries.

Name

Type

Description

@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

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

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

String

Set the path of an alternate hosts configuration file to use instead of the one provided by the os.

The default value is null, so the operating system hosts config is used.

@hostsValue

Buffer

Set an alternate hosts configuration file to use instead of the one provided by the os.

The value should contain the hosts content literaly, for instance 127.0.0.1 localhost

The default value is null, so the operating system hosts config is used.

@maxQueries

Number (int)

Set the maximum number of queries when an hostname is resolved.

@ndots

Number (int)

Set the ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.

@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

Number (long)

Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

@rdFlag

Boolean

Set the DNS queries Recursion Desired flag value.

@rotateServers

Boolean

Set to true 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.

@searchDomains

Array of String

Set the lists of DNS search domains.

When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.

@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 8.8.8.8 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 "8.8.8.8" and "8.8.4.4".

AggregateOptions

Options used to configure aggregate operations.

Name

Type

Description

@allowDiskUse

Boolean

Set the flag if writing to temporary files is enabled.

@batchSize

Number (int)

Set the batch size for methods loading found data in batches.

@maxTime

Number (long)

Set the time limit in milliseconds for processing operations on a cursor.

AmqpClientOptions

Configures the AMQP Client. You can also configure the underlying Proton instance. Refer to for details.

Name

Type

Description

@connectTimeout

Number (int)

@containerId

String

Sets the container id.

@crlPaths

Array of String

@crlValues

Array of Buffer

@enabledCipherSuites

Array of String

@enabledSaslMechanisms

Array of String

@enabledSecureTransportProtocols

Array of String

@heartbeat

Number (int)

@host

String

Sets the host.

@hostnameVerificationAlgorithm

String

@idleTimeout

Number (int)

@idleTimeoutUnit

TimeUnit

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

@localAddress

String

@logActivity

Boolean

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

@maxFrameSize

Number (int)

@metricsName

String

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

@password

String

Sets the password.

@port

Number (int)

Sets the port.

@receiveBufferSize

Number (int)

@reconnectAttempts

Number (int)

@reconnectInterval

Number (long)

@reuseAddress

Boolean

@reusePort

Boolean

@sendBufferSize

Number (int)

@sniServerName

String

@soLinger

Number (int)

@ssl

Boolean

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

@tcpFastOpen

Boolean

@tcpKeepAlive

Boolean

@tcpNoDelay

Boolean

@tcpQuickAck

Boolean

@trafficClass

Number (int)

@trustAll

Boolean

@useAlpn

Boolean

Set the ALPN usage.

@username

String

Sets the username.

@virtualHost

String

AmqpReceiverOptions

Configures the AMQP Receiver.

Name

Type

Description

@autoAcknowledgement

Boolean

Sets the auto-acknowledgement. When enabled (default), the messages are automatically acknowledged. If set to false, the messages must be acknowledged explicitly using link, link and link.

@capabilities

Array of String

Sets the list of capabilities to be set on the receiver source terminus.

@capabilitys

Array of String

Adds a capability to be set on the receiver source terminus.

@durable

Boolean

Sets the durability.

Passing true sets the expiry policy of the source to NEVER and the durability of the source to UNSETTLED_STATE.

@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.

The address provided by the peer can then be inspected using the link method on the link received once opened.

@linkName

String

-

@maxBufferedMessages

Number (int)

Sets the max buffered messages. This message can be used to configure the initial credit of a receiver.

@qos

String

Sets the local QOS config.

AmqpSenderOptions

Configures the AMQP Sender.

Name

Type

Description

@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.

true by default.

@capabilities

Array of String

Sets the list of capabilities to be set on the sender target terminus.

@capabilitys

Array of String

Adds a capability to be set on the sender target terminus.

@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.

The address provided by the peer can then be inspected using the link method on the link received once opened.

@linkName

String

-

ApolloWSOptions

Options for configuring the link.

Name

Type

Description

@keepAlive

Number (long)

Set the interval in milliseconds to send KEEPALIVE messages to all clients. Defaults to 30000.

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).

Name

Type

Description

@argName

String

Sets the argument name of this link.

@defaultValue

String

Sets the default value of this link.

@description

String

Sets the description of the link.

@hidden

Boolean

Sets whether or not the current link is hidden.

@index

Number (int)

Sets the argument index.

@multiValued

Boolean

Sets whether or not the argument can receive several values. Only the last argument can receive several values.

@required

Boolean

Sets whether or not the current link is required.

AuthOptions

A common base object for authentication options.


Name

Type

Description

Authenticator

Data Object representing an authenticator at rest.

Name

Type

Description

@counter

Number (long)

-

@credID

String

-

@publicKey

String

-

@type

String

-

@userName

String

-

BlockingQueryOptions

Options used to perform blocking query that used to wait for a potential change using long polling.

Name

Type

Description

@index

Number (long)

Set index indicating that the client wishes to wait for any changes subsequent to that index.

@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).

BridgeOptions

Specify the event bus bridge options.

Name

Type

Description

BridgeOptions

Specify the event bus bridge options.

Name

Type

Description

@pointToPoint

Boolean

-

BulkOperation

Contains all data needed for one operation of a bulk write operation.

Name

Type

Description

@document

Json object

Sets the document, used by insert, replace, and update operations

@filter

Json object

Sets the filter document, used by replace, update, and delete operations

@multi

Boolean

Sets the multi flag, used by update and delete operations

@type

BulkOperationType

Sets the operation type

@upsert

Boolean

Sets the upsert flag, used by update and replace operations

BulkWriteOptions

Options for configuring bulk write operations.

Name

Type

Description

@ordered

Boolean

Set the ordered option

@writeOption

WriteOption

Set the write option

CassandraClientOptions

Eclipse Vert.x Cassandra client options.

Name

Type

Description

@contactPoints

Number (int)

Adds a contact point to use for the initial connection to the cluster

@keyspace

String

Set the keyspace to use when creating the Cassandra session. Defaults to null.

Check

Holds check properties

Name

Type

Description

@id

String

Set the ID of check

@name

String

Set the name of check

@nodeName

String

Set the name of node

@notes

String

Set the human-readable note of check

@output

String

Set the output of check

@serviceId

String

Set the ID of service with which this check associated

@serviceName

String

Set the name of service with which this check associated

@status

CheckStatus

Set the status of check

CheckList

Holds result of checks query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested list of checks

CheckOptions

Options used to register checks in Consul.

Name

Type

Description

@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

String

Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol. The state of the check will be updated at the given Interval by probing the configured endpoint. The endpoint must be represented as address:port/service

@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 TLSSkipVerify to true.

@http

String

Set HTTP address to check. Also you should set checking interval

@id

String

Set check ID

@interval

String

Set checking interval

@name

String

Set check name. This is mandatory field

@notes

String

Set check notes

@scriptArgs

Array of String

Set scriptArgs. Also you should set checking interval

@serviceId

String

Set the service ID to associate the registered check with an existing service provided by the agent.

@status

CheckStatus

Set the check status to specify the initial state of the health check.

@tcp

String

Set TCP address to check. Also you should set checking interval

@tlsSkipVerify

Boolean

Specifies if the certificate for an HTTPS check should not be verified.

@ttl

String

Set Time to Live of check.

CheckQueryOptions

Options used to requesting list of checks

Name

Type

Description

@near

String

Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

CheckResult


Name

Type

Description

@data

Json object

-

@id

String

-

@up

Boolean

-

CircuitBreakerOptions

Circuit breaker configuration options. All time are given in milliseconds.

Name

Type

Description

@failuresRollingWindow

Number (long)

Sets the rolling window used for metrics.

@fallbackOnFailure

Boolean

Sets whether or not the fallback is executed on failure, even when the circuit is closed.

@maxFailures

Number (int)

Sets the maximum number of failures before opening the circuit.

@maxRetries

Number (int)

Configures the number of times the circuit breaker tries to redo the operation before failing.

@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

Number (long)

Sets the rolling window used for metrics.

@notificationAddress

String

Sets the event bus address on which the circuit breaker publish its state change.

@notificationPeriod

Number (long)

Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its current state.

@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. -1 disables this feature.

@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

Base class for Client options

Name

Type

Description

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

ClusterDescription

A detailed description of the cluster

Name

Type

Description

@clusterId

String

Set the cluster ID

Config

A configuration object containing the configuration entries for a resource

Name

Type

Description

ConfigChange

A structure representing a configuration change.

Name

Type

Description

@newConfiguration

Json object

Sets the new configuration.

@previousConfiguration

Json object

Sets the previous configuration.

ConfigEntry

A class representing a configuration entry containing name, value and additional metadata

Name

Type

Description

@default

Boolean

Set whether the config value is the default or if it's been explicitly set

@name

String

Set the config name

@readOnly

Boolean

Set whether the config is read-only and cannot be updated

@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

ConfigSource

Set the source of this configuration entry

@value

String

Set the value or null. Null is returned if the config is unset or if isSensitive is true

ConfigResource

A class representing resources that have configuration

Name

Type

Description

@default

Boolean

Set if this is the default resource of a resource type. Resource name is empty for the default resource.

@name

String

Set the resource name

@type

Type

Set the resource type

ConfigRetrieverOptions

Options to configure the ConfigRetriever.

Name

Type

Description

@includeDefaultStores

Boolean

Enables or disables the inclusion of the default stored in the configuration.

@scanPeriod

Number (long)

Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.

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.

Name

Type

Description

@config

Json object

Sets the configuration of the store

@format

String

Sets the format of the configuration that is retrieved from the store.

@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

String

Sets the configuration type

ConfigSynonym

Class representing a configuration synonym of a link

Name

Type

Description

@name

String

Set the name of this configuration

@source

ConfigSource

Set the source of this configuration

@value

String

Set the value of this configuration, which may be null if the configuration is sensitive

ConsulClientOptions

Options used to create Consul client.

Name

Type

Description

@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

Array of 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:

  • : [ "h2", "http/1.1" ]
  • otherwise: [link]

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@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

Number (int)

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

@defaultHost

String

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

@defaultPort

Number (int)

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

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@followRedirects

Boolean

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

@forceSni

Boolean

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

@http2ClearTextUpgrade

Boolean

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

@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.

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

@http2KeepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@http2MaxPoolSize

Number (int)

Set the maximum pool size for HTTP/2 connections

@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.

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

@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

TimeUnit

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

@keepAlive

Boolean

Set whether keep alive is enabled on the client

@keepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@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

Boolean

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

@maxChunkSize

Number (int)

Set the maximum HTTP chunk size

@maxHeaderSize

Number (int)

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

@maxInitialLineLength

Number (int)

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

@maxPoolSize

Number (int)

Set the maximum pool size for connections

@maxRedirects

Number (int)

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

@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

Number (int)

Set the max websocket frame size

@maxWebSocketMessageSize

Number (int)

Set the max websocket message size

@metricsName

String

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

@pipelining

Boolean

Set whether pipe-lining is enabled on the client

@pipeliningLimit

Number (int)

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

@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

HttpVersion

Set the protocol version.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@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

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@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.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@tryUseCompression

Boolean

Set whether compression is enabled

@tryUsePerFrameWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-frame deflate compression extension.

@tryUsePerMessageWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-message deflate compression extension.

@tryWebSocketDeflateFrameCompression

Boolean

@useAlpn

Boolean

Set the ALPN usage.

@userAgent

String

Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

@userAgentEnabled

Boolean

Sets whether the Web Client should send a user agent header. Defaults to true.

@verifyHost

Boolean

Set whether hostname verification is enabled

@webSocketClosingTimeout

Number (int)

Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.

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.

Set 0L or a negative value to disable.

@webSocketCompressionAllowClientNoContext

Boolean

Set whether the client_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

@webSocketCompressionLevel

Number (int)

Set the WebSocket deflate compression level.

@webSocketCompressionRequestServerNoContext

Boolean

Set whether the server_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

ConsumerGroupDescription

A detailed description of a single consumer group in the cluster

Name

Type

Description

@groupId

String

Set the id of the consumer group

@partitionAssignor

String

Set the consumer group partition assignor

@simpleConsumerGroup

Boolean

Set if consumer group is simple or not

@state

ConsumerGroupState

Set the consumer group state, or UNKNOWN if the state is too new for us to parse

ConsumerGroupListing

A listing of a consumer group in the cluster.

Name

Type

Description

@groupId

String

Set the consumer group id

@simpleConsumerGroup

Boolean

Set if consumer group is simple or not

Coordinate

Holds network coordinates of node

Name

Type

Description

@adj

Number (float)

Set adjustment

@err

Number (float)

Set error

@height

Number (float)

Set height

@node

String

Set name of node

@vec

Array of Number (Float)

Set vector

CoordinateList

Holds result of network coordinates query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested coordinates

CopyOptions

Describes the copy (and move) options.

Name

Type

Description

@atomicMove

Boolean

Whether move should be performed as an atomic filesystem operation. Defaults to false.

@copyAttributes

Boolean

Whether the file attributes should be copied. Defaults to false.

@nofollowLinks

Boolean

Whether symbolic links should not be followed during copy or move operations. Defaults to false.

@replaceExisting

Boolean

Whether an existing file, empty directory, or link should be replaced. Defaults to false.

DB2ConnectOptions

Connect options for configuring link or link.

Name

Type

Description

@cachePreparedStatements

Boolean

Set whether prepared statements cache should be enabled.

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@database

String

Specify the default database for the connection.

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Specify the host for connecting to the server.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@password

String

Specify the user password to be used for the authentication.

@pipeliningLimit

Number (int)

-

@port

Number (int)

Specify the port for connecting to the server.

@preparedStatementCacheMaxSize

Number (int)

Set the maximum number of prepared statements that the connection will cache.

@preparedStatementCacheSqlLimit

Number (int)

Set the maximum length of prepared statement SQL string that the connection will cache.

This is an helper setting the link.

@properties

String

Set properties for this client, which will be sent to server at the connection start.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@user

String

Specify the user account to be used for the authentication.

DKIMSignOptions

This represents the options used to perform DKIM Signature signing action. See: https://tools.ietf.org/html/rfc6376

Name

Type

Description

@auid

String

Sets the Agent or User Identifier(AUID)

@bodyCanonAlgo

CanonicalizationAlgorithm

Sets the canonicalization algorithm for mail body.

@bodyLimit

Number (int)

Sets the body limit to sign.

@copiedHeaders

Array of String

Sets the copied headers used in DKIM.

@expireTime

Number (long)

Sets the expire time in seconds when the signature sign will be expired.

Success call of this method indicates that the signature sign timestamp is enabled.

@headerCanonAlgo

CanonicalizationAlgorithm

Sets the canonicalization algorithm for signed headers.

@privateKey

String

Sets the PKCS#8 format private key used to sign the email.

@privateKeyPath

String

Sets the PKCS#8 format private key file path.

@sdid

String

Sets the Singing Domain Identifier(SDID).

@selector

String

Sets the selector used to query the public key.

@signAlgo

DKIMSignAlgorithm

Sets the signing algorithm.

@signatureTimestamp

Boolean

Sets to enable or disable signature sign timestmap. Default is disabled.

@signedHeaders

Array of String

Sets the email signedHeaders used to sign.

DatagramSocketOptions

Options used to configure a datagram socket.

Name

Type

Description

@broadcast

Boolean

Set if the socket can send or receive broadcast packets

@ipV6

Boolean

Set if IP v6 should be used

@logActivity

Boolean

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

@loopbackModeDisabled

Boolean

Set if loopback mode is disabled

@multicastNetworkInterface

String

Set the multicast network interface address

@multicastTimeToLive

Number (int)

Set the multicast ttl value

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@trafficClass

Number (int)

Set the value of traffic class

DcCoordinates

Holds coordinates of servers in datacenter

Name

Type

Description

@datacenter

String

Set datacenter

DeliveryOptions

Delivery options are used to configure message delivery.

Delivery options allow to configure delivery timeout and message codec name, and to provide any headers that you wish to send with the message.


Name

Type

Description

@codecName

String

Set the codec name.

@headers

String

Add a message header.

Message headers can be sent with any message and will be accessible with link at the recipient.

@localOnly

Boolean

Whether a message should be delivered to local consumers only. Defaults to false.

This option is effective in clustered mode only and does not apply to reply messages.

@sendTimeout

Number (long)

Set the send timeout.

DeploymentOptions

Options for configuring a verticle deployment.


Name

Type

Description

@config

Json object

Set the JSON configuration that will be passed to the verticle(s) when it's deployed

@ha

Boolean

Set whether the verticle(s) will be deployed as HA.

@instances

Number (int)

Set the number of instances that should be deployed.

@maxWorkerExecuteTime

Number (long)

Sets the value of max worker execute time, in link.

The default value of link is

@maxWorkerExecuteTimeUnit

TimeUnit

Set the time unit of maxWorkerExecuteTime

@worker

Boolean

Set whether the verticle(s) should be deployed as a worker verticle

@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

Number (int)

Set the maximum number of worker threads to be used by the Vert.x instance.

DnsClientOptions

Configuration options for Vert.x DNS client.

Name

Type

Description

@host

String

Set the host name to be used by this client in requests.

@logActivity

Boolean

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

@port

Number (int)

Set the port to be used by this client in requests.

@queryTimeout

Number (long)

Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

@recursionDesired

Boolean

Set whether or not recursion is desired

DropwizardMetricsOptions

Vert.x Dropwizard metrics configuration.

Name

Type

Description

@baseName

String

Set a custom baseName for metrics.

@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

Boolean

Set whether metrics will be enabled on the Vert.x instance.

@jmxDomain

String

Set the JMX domain to use when JMX metrics are enabled.

@jmxEnabled

Boolean

Set whether JMX will be enabled on the Vert.x instance.

@registryName

String

Set the name used for registering the metrics in the Dropwizard shared registry.

Event

Holds properties of Consul event

Name

Type

Description

@id

String

Set ID of event

@lTime

Number (int)

Set the Lamport clock time

@name

String

Set name of event

@node

String

Set regular expression to filter by node name

@payload

String

Set payload of event

@service

String

Set regular expression to filter by service

@tag

String

Set regular expression to filter by tag

@version

Number (int)

Set version

EventBusOptions

Options to configure the event bus.

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log.

@clientAuth

ClientAuth

Set whether client auth is required

@clusterNodeMetadata

Json object

Set information about this node when Vert.x is clustered.

The data may be used by the link to select a node for a given message. For example, it could be used to implement a partioning strategy.

The default link does not use the node metadata.

@clusterPingInterval

Number (long)

Set the value of cluster ping interval, in ms.

@clusterPingReplyInterval

Number (long)

Set the value of cluster ping reply interval, in ms.

@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.

The default value is null which means use the same as the cluster hostname.

@clusterPublicPort

Number (int)

See link for an explanation.

@connectTimeout

Number (int)

Sets the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Sets the host. Defaults to null.

When the clustered eventbus starts, it tries to bind to the provided host. If host is null, then it tries to bind to the same host as the underlying cluster manager. As a last resort, an address will be picked among the available network interfaces.

@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

TimeUnit

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

@logActivity

Boolean

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

@port

Number (int)

Sets the port.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Sets the value of reconnect attempts.

@reconnectInterval

Number (long)

Set the reconnect interval.

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted.

@useAlpn

Boolean

Set the ALPN usage.

EventList

Holds result of events query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested events

EventListOptions

Holds options for events list request

Name

Type

Description

@name

String

Set event name for filtering on events

EventOptions

Options used to trigger a new user event.

Name

Type

Description

@node

String

Set regular expression to filter by node name

@payload

String

Set payload of event

@service

String

Set regular expression to filter by service

@tag

String

Set regular expression to filter by tag

FileSystemOptions

Vert.x file system base configuration, this class can be extended by provider implementations to configure those specific implementations.

Name

Type

Description

@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 true.

@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

Boolean

Set to true to cache files on the real file system when the filesystem performs class path resolving.

FindOptions

Options used to configure find operations.

Name

Type

Description

@batchSize

Number (int)

Set the batch size for methods loading found data in batches.

@fields

Json object

Set the fields

@limit

Number (int)

Set the limit

@skip

Number (int)

Set the skip

@sort

Json object

Set the sort document

Frame

Represents a STOMP frame. STOMP frames are structured as follows. It starts by a command, followed by a set of headers. Then the frame may have a body and is finished by a 0 byte. This class represents this structure and provide access to the different parts.

This class is NOT thread-safe.


Name

Type

Description

@ack

String

Gets the value of the ack header.

@body

Buffer

Sets the body of the frame.

@bodyAsString

String

Gets the body of the frames as a String encoded in the frame encoding.

@command

Command

Sets the frame command.

@destination

String

-

@headers

String

Sets the headers of the frames.

@id

String

-

@receipt

String

-

@transaction

String

-

GoAway

A frame.

Name

Type

Description

@debugData

Buffer

Set the additional debug data

@errorCode

Number (long)

@lastStreamId

Number (int)

Set the last stream id.

GraphQLHandlerOptions

Options for configuring the link.

Name

Type

Description

@requestBatchingEnabled

Boolean

Whether request batching should be enabled. Defaults to false.

@requestMultipartEnabled

Boolean

Whether request multipart should be enabled. Defaults to false.

GraphiQLHandlerOptions

Embedded GraphiQL user interface options.

Name

Type

Description

@enabled

Boolean

Whether the GraphiQL development tool should be enabled. Defaults to false.

@graphQLUri

String

Set the GraphQL endpoint URI. Defaults to the path used to get the GraphiQL user interface.

@headers

String

A fixed set of HTTP headers to add to GraphiQL requests. Defaults to null.

@query

String

Initial value of the query area in the GraphiQL user interface. Defaults to null.

@variables

Json object

Initial value of the variables area in the GraphiQL user interface. Defaults to null.

GridFsDownloadOptions

Options used to configure downloads from GridFS.

Name

Type

Description

@revision

Number (Integer)

-

GridFsUploadOptions

Name

Type

Description

@chunkSizeBytes

Number (Integer)

-

@metadata

Json object

-

HtdigestCredentials

Credentials specific to the link authentication provider

Name

Type

Description

@algorithm

String

-

@cnonce

String

-

@method

String

-

@nc

String

-

@nonce

String

-

@opaque

String

-

@password

String

-

@qop

String

-

@realm

String

-

@response

String

-

@uri

String

-

@username

String

-

HtpasswdAuthOptions

Options configuring htpasswd authentication.

Name

Type

Description

@htpasswdFile

String

-

@plainTextEnabled

Boolean

-

Http2PushMapping

Name

Type

Description

@extensionTarget

String

-

@filePath

String

-

@noPush

Boolean

-

Http2Settings

HTTP2 settings, the settings is initialized with the default HTTP/2 values.

The settings expose the parameters defined by the HTTP/2 specification, as well as extra settings for protocol extensions.


Name

Type

Description

@headerTableSize

Number (long)

Set HTTP/2 setting.

@initialWindowSize

Number (int)

Set the HTTP/2 setting

@maxConcurrentStreams

Number (long)

Set the HTTP/2 setting

@maxFrameSize

Number (int)

Set the HTTP/2 setting

@maxHeaderListSize

Number (long)

Set the HTTP/2 setting

@pushEnabled

Boolean

Set the HTTP/2 setting

HttpClientOptions

Options describing how an link will make connections.

Name

Type

Description

@alpnVersions

Array of 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:

  • : [ "h2", "http/1.1" ]
  • otherwise: [link]

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@decoderInitialBufferSize

Number (int)

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

@defaultHost

String

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

@defaultPort

Number (int)

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

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@forceSni

Boolean

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

@http2ClearTextUpgrade

Boolean

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

@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.

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

@http2KeepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@http2MaxPoolSize

Number (int)

Set the maximum pool size for HTTP/2 connections

@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.

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

@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

TimeUnit

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

@keepAlive

Boolean

Set whether keep alive is enabled on the client

@keepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@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

Boolean

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

@maxChunkSize

Number (int)

Set the maximum HTTP chunk size

@maxHeaderSize

Number (int)

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

@maxInitialLineLength

Number (int)

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

@maxPoolSize

Number (int)

Set the maximum pool size for connections

@maxRedirects

Number (int)

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

@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

Number (int)

Set the max WebSocket frame size

@maxWebSocketMessageSize

Number (int)

Set the max WebSocket message size

@metricsName

String

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

@pipelining

Boolean

Set whether pipe-lining is enabled on the client

@pipeliningLimit

Number (int)

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

@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

HttpVersion

Set the protocol version.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@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

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@tryUseCompression

Boolean

Set whether compression is enabled

@tryUsePerFrameWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-frame deflate compression extension.

@tryUsePerMessageWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-message deflate compression extension.

@tryWebSocketDeflateFrameCompression

Boolean

@useAlpn

Boolean

Set the ALPN usage.

@verifyHost

Boolean

Set whether hostname verification is enabled

@webSocketClosingTimeout

Number (int)

Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.

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.

Set 0L or a negative value to disable.

@webSocketCompressionAllowClientNoContext

Boolean

Set whether the client_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

@webSocketCompressionLevel

Number (int)

Set the WebSocket deflate compression level.

@webSocketCompressionRequestServerNoContext

Boolean

Set whether the server_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

HttpLocation

Represents the location of a HTTP endpoint. This object (its json representation) will be used as "location" in a service record.

Name

Type

Description

@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

String

Sets the host.

@port

Number (int)

Sets the port

@root

String

Sets the path of the service (root)

@ssl

Boolean

Sets whether or not the HTTP service is using https.

HttpMethod

Represents an HTTP method.

Name

Type

Description

HttpServerOptions

Represents options used by an link instance

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@acceptUnmaskedFrames

Boolean

Set true when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true. It's set to false as default.

@alpnVersions

Array of HttpVersion

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

@clientAuth

ClientAuth

Set whether client auth is required

@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 deflate/gzip compression in the Accept-Encoding 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

Boolean

Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@decoderInitialBufferSize

Number (int)

Set the initial buffer size for the HTTP decoder

@decompressionSupported

Boolean

Set whether the server supports decompression

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@handle100ContinueAutomatically

Boolean

Set whether 100 Continue should be handled automatically

@host

String

Set the host

@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.

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

@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

TimeUnit

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

@logActivity

Boolean

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

@maxChunkSize

Number (int)

Set the maximum HTTP chunk size that link will receive

@maxHeaderSize

Number (int)

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

@maxInitialLineLength

Number (int)

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

@maxWebSocketFrameSize

Number (int)

Set the maximum WebSocket frames size

@maxWebSocketMessageSize

Number (int)

Set the maximum WebSocket message size

@perFrameWebSocketCompressionSupported

Boolean

Enable or disable support for the WebSocket per-frame deflate compression extension.

@perMessageWebSocketCompressionSupported

Boolean

Enable or disable support for WebSocket per-message deflate compression extension.

@port

Number (int)

Set the port

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the server behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

@webSocketAllowServerNoContext

Boolean

Set whether the WebSocket server will accept the server_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

@webSocketCompressionLevel

Number (int)

Set the WebSocket compression level.

@webSocketPreferredClientNoContext

Boolean

Set whether the WebSocket server will accept the client_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

@webSocketSubProtocols

Array of String

Set the WebSocket list of sub-protocol supported by the server.

HttpTermOptions

The web term configuration options.

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@acceptUnmaskedFrames

Boolean

Set true when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true. It's set to false as default.

@alpnVersions

Array of HttpVersion

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

@authOptions

Json object

Set the auth options.

@charset

String

Set the charset used for encoding / decoding text data from/to SockJS

@clientAuth

ClientAuth

Set whether client auth is required

@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 deflate/gzip compression in the Accept-Encoding 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

Boolean

Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@decoderInitialBufferSize

Number (int)

Set the initial buffer size for the HTTP decoder

@decompressionSupported

Boolean

Set whether the server supports decompression

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@handle100ContinueAutomatically

Boolean

Set whether 100 Continue should be handled automatically

@host

String

Set the host

@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.

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

@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

TimeUnit

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

@intputrc

String

The path of the inputrc config.

@logActivity

Boolean

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

@maxChunkSize

Number (int)

Set the maximum HTTP chunk size that will receive

@maxHeaderSize

Number (int)

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

@maxInitialLineLength

Number (int)

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

@maxWebSocketFrameSize

Number (int)

Set the maximum WebSocket frames size

@maxWebSocketMessageSize

Number (int)

Set the maximum WebSocket message size

@perFrameWebSocketCompressionSupported

Boolean

Enable or disable support for the WebSocket per-frame deflate compression extension.

@perMessageWebSocketCompressionSupported

Boolean

Enable or disable support for WebSocket per-message deflate compression extension.

@port

Number (int)

Set the port

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@shellHtmlResource

Buffer

Set shell.html resource to use.

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@sockJSPath

String

Configure the SockJS path, the default value is /term/*.

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@termJsResource

Buffer

Set term.js resource to use.

@tracingPolicy

TracingPolicy

Set the tracing policy for the server behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

@vertsShellJsResource

Buffer

Set vertxshell.js resource to use.

@webSocketAllowServerNoContext

Boolean

Set whether the WebSocket server will accept the server_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

@webSocketCompressionLevel

Number (int)

Set the WebSocket compression level.

@webSocketPreferredClientNoContext

Boolean

Set whether the WebSocket server will accept the client_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

@webSocketSubProtocols

Array of String

Set the WebSocket list of sub-protocol supported by the server.

IndexModel

Name

Type

Description

@key

Json object

Get the index key

IndexOptions

Options used to configure index.

Name

Type

Description

@background

Boolean

Create the index in the background

@bits

Number (Integer)

Gets the number of precision of the stored geohash value of the location data in 2d indexes.

@bucketSize

Number (Double)

Gets the specified the number of units within which to group the location values for geoHaystack Indexes

@defaultLanguage

String

Gets the language for a text index.

The language that determines the list of stop words and the rules for the stemmer and tokenizer.

@languageOverride

String

Gets the name of the field that contains the language string.

For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.

@max

Number (Double)

Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..

@min

Number (Double)

Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..

@name

String

Gets the name of the index.

@partialFilterExpression

Json object

Get the filter expression for the documents to be included in the index or null if not set

@sparse

Boolean

If true, the index only references documents with the specified field

@sphereVersion

Number (Integer)

Gets the 2dsphere index version number.

@storageEngine

Json object

Gets the storage engine options document for this index.

@textVersion

Number (Integer)

The text index version number.

@unique

Boolean

Gets if the index should be unique.

@version

Number (Integer)

Gets the index version number.

@weights

Json object

Gets the weighting object for use with a text index

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.

JDBCAuthOptions

Options configuring JDBC authentication.

Name

Type

Description

@authenticationQuery

String

Set the authentication query to use. Use this if you want to override the default authentication query.

@config

Json object

The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

@datasourceName

String

Set the data source name to use, only use in shared mode.

@permissionsQuery

String

Set the permissions query to use. Use this if you want to override the default permissions query.

@rolesPrefix

String

Set the role prefix to distinguish from permissions when checking for isPermitted requests.

@rolesQuery

String

Set the roles query to use. Use this if you want to override the default roles query.

@shared

Boolean

Set whether the JDBC client is shared or non shared.

JDBCAuthenticationOptions

Options configuring JDBC authentication.

Name

Type

Description

@authenticationQuery

String

Set the authentication query to use. Use this if you want to override the default authentication query.

JDBCAuthorizationOptions

Options configuring JDBC authentication.

Name

Type

Description

@permissionsQuery

String

Set the permissions query to use. Use this if you want to override the default permissions query.

@rolesQuery

String

Set the roles query to use. Use this if you want to override the default roles query.

JDBCConnectOptions

Name

Type

Description

@connectTimeout

Number (int)

-

@dataSourceImplementation

String

-

@database

String

-

@idleTimeout

Number (int)

-

@jdbcUrl

String

-

@metricsEnabled

Boolean

-

@password

String

-

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@user

String

-

JWTAuthOptions

Options describing how an JWT Auth should behave.

Name

Type

Description

@jwks

Array of Json object

-

@permissionsClaimKey

String

-

JWTOptions

Name

Type

Description

@algorithm

String

-

@audience

Array of String

-

@audiences

Array of String

-

@expiresInMinutes

Number (int)

-

@expiresInSeconds

Number (int)

-

@header

Json object

-

@ignoreExpiration

Boolean

-

@issuer

String

-

@leeway

Number (int)

-

@noTimestamp

Boolean

-

@permissions

Array of String

The permissions of this token.

@scopeDelimiter

String

@scopes

Array of String

@subject

String

-

JdkSSLEngineOptions

Configures a link to use the JDK ssl engine implementation.

Name

Type

Description

JksOptions

Key or trust store options configuring private key and/or certificates based on Java Keystore files.

Name

Type

Description

@password

String

Set the password for the key store

@path

String

Set the path to the key store

@type

String

-

@value

Buffer

Set the key store as a buffer

KafkaClientOptions

Generic KafkaClient options.

Name

Type

Description

@tracePeerAddress

String

Set the Kafka address to show in trace tags. Or leave it unset to automatically pick up bootstrap server from config instead.

@tracingPolicy

TracingPolicy

Set the Kafka tracing policy.

KeyStoreOptions

Options describing how an JWT KeyStore should behave. This is an extended version core's link.

This extension sets the default type to the runtime keystore type (for compatibility, reasons) plus it allows the configuration of password per key using link.


Name

Type

Description

@password

String

-

@passwordProtection

String

-

@path

String

-

@type

String

-

KeyValue

Represents key/value pair stored in Consul

Name

Type

Description

@createIndex

Number (long)

Set the internal index value that represents when the entry was created.

@flags

Number (long)

Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

@key

String

Set the key

@lockIndex

Number (long)

Set the number of times this key has successfully been acquired in a lock.

@modifyIndex

Number (long)

Set the last index that modified this key.

@session

String

Set the session that owns the lock

@value

String

Set the value

KeyValueList

Holds result of key/value pairs query

Name

Type

Description

@index

Number (long)

Set Consul index

KeyValueOptions

Options used to put key/value pair to Consul.

Name

Type

Description

@acquireSession

String

Set session ID for lock acquisition operation.

@casIndex

Number (long)

Set the Check-And-Set index. If the index is 0, 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

Number (long)

Set the flags. Flags is an value between 0 and 264-1 that can be attached to each entry. Clients can choose to use this however makes sense for their application.

@releaseSession

String

Set session ID for lock release operation.

LdapAuthenticationOptions

Ldap auth configuration options

Name

Type

Description

@authenticationMechanism

String

sets the authentication mechanism. default to 'simple' if not set

@authenticationQuery

String

Set the query to use to authenticate a user. This is used to determine the actual lookup to use when looking up a user with a particular id. An example is `uid={0},ou=users,dc=foo,dc=com` - Note that the element `{0}` is substituted with the user id to create the actual lookup.

@referral

String

Set the referral property. Default to 'follow' if not set

@url

String

Set the url to the LDAP server. The url must start with `ldap://` and a port must be specified.

ListConsumerGroupOffsetsOptions

Name

Type

Description

ListOffsetsResultInfo

Name

Type

Description

@leaderEpoch

Number (Integer)

Set the leader epoch

@offset

Number (long)

Set the offset

@timestamp

Number (long)

Set the timestamp

MailConfig

represents the configuration of a mail service with mail server hostname, port, security options, login options and login/password

Name

Type

Description

@allowRcptErrors

Boolean

set if sending allows rcpt errors

if true, the mail will be sent to the recipients that the server accepted, if any

@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

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@disableEsmtp

Boolean

set if ESMTP should be tried as first command (EHLO)

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.

@enableDKIM

Boolean

Sets true to enable DKIM Signatures, sets false to disable it.

This is used most for temporary disable DKIM without removing DKIM opations from current config.

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@hostname

String

Set the hostname of the smtp server.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@keepAlive

Boolean

set if connection pool is enabled default is true

if the connection pooling is disabled, the max number of sockets is enforced nevertheless

@keyStore

String

get the key store filename to be used when opening SMTP connections

if not set, an options object will be created based on other settings (ssl and trustAll)

@keyStorePassword

String

get the key store password to be used when opening SMTP connections

@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

Boolean

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

@login

LoginOption

Set the login mode for the connection.

Either DISABLED, OPTIONAL or REQUIRED

@maxPoolSize

Number (int)

set the max allowed number of open connections to the mail server if not set the default is 10

@metricsName

String

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

@ownHostname

String

set the hostname to be used for HELO/EHLO and the Message-ID

@password

String

Set the password for the login.

@pipelining

Boolean

Sets to enable/disable the pipelining capability if SMTP server supports it.

@port

Number (int)

Set the port of the smtp server.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@starttls

StartTLSOptions

Set the tls security mode for the connection.

Either NONE, OPTIONAL or REQUIRED

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@userAgent

String

Sets the Mail User Agent(MUA) name.

It is used to generate the boundary in case of MultiPart email and the Message-ID.

If null is set, DEFAULT_USER_AGENT is used.

@username

String

Set the username for the login.

MailMessage

represent a mail message that can be sent via the MailClient

Name

Type

Description

@bcc

Array of String

set list of bcc addresses

@bounceAddress

String

set bounce address of this mail

@cc

Array of String

set list of cc addresses

@fixedHeaders

Boolean

set whether our own headers should be the only headers added to the message

@from

String

set from address of this mail

@headers

String

Add a message header.

@html

String

set the html text of this mail

@subject

String

set the subject of this mail

@text

String

set the plain text of this mail

@to

Array of String

set list of to addresses

MailResult

Represent the result of the sendMail operation

Name

Type

Description

@messageID

String

@recipients

Array of String

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.

Name

Type

Description

@enable

Boolean

Set maintenance mode to enabled: true to enter maintenance mode or false to resume normal operation. This flag is required.

@id

String

Set the ID of service. This field is required.

@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

A match for a value.

Name

Type

Description

@alias

String

Set an alias that would replace the label value when it matches.

@domain

MetricsDomain

Set the label domain, restricting this rule to a single domain.

@label

String

Set the label name. The match will apply to the values related to this key.

@type

MatchType

Set the type of matching to apply.

@value

String

Set the matched value.

Match

A match for a value.

Name

Type

Description

@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

MatchType

Set the type of matching to apply.

@value

String

Set the matched value.

MemberAssignment

A description of the assignments of a specific group member

Name

Type

Description

MemberDescription

A detailed description of a single group instance in the cluster

Name

Type

Description

@clientId

String

Set the client id of the group member

@consumerId

String

Set the consumer id of the group member

@host

String

Set the host where the group member is running

MetricsNaming

Options for naming all metrics

Name

Type

Description

@clientProcessingPending

String

-

@clientProcessingTime

String

-

@clientQueuePending

String

-

@clientQueueTime

String

-

@clientResetsCount

String

-

@datagramBytesRead

String

-

@datagramBytesWritten

String

-

@datagramErrorCount

String

-

@ebBytesRead

String

-

@ebBytesWritten

String

-

@ebDelivered

String

-

@ebDiscarded

String

-

@ebHandlers

String

-

@ebPending

String

-

@ebProcessed

String

-

@ebPublished

String

-

@ebReceived

String

-

@ebReplyFailures

String

-

@ebSent

String

-

@httpActiveRequests

String

-

@httpActiveWsConnections

String

-

@httpQueuePending

String

-

@httpQueueTime

String

-

@httpRequestBytes

String

-

@httpRequestResetsCount

String

-

@httpRequestsCount

String

-

@httpResponseBytes

String

-

@httpResponseTime

String

-

@httpResponsesCount

String

-

@netActiveConnections

String

-

@netBytesRead

String

-

@netBytesWritten

String

-

@netErrorCount

String

-

@poolCompleted

String

-

@poolInUse

String

-

@poolQueuePending

String

-

@poolQueueTime

String

-

@poolUsage

String

-

@poolUsageRatio

String

-

MetricsOptions

Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific implementations.

Name

Type

Description

@enabled

Boolean

Set whether metrics will be enabled on the Vert.x instance.

MicrometerMetricsOptions

Vert.x micrometer configuration.

It is required to set either influxDbOptions, prometheusOptions or jmxMetricsOptions (or, programmatically, micrometerRegistry) in order to actually report metrics.


Name

Type

Description

@disabledMetricsCategories

Array of String

Sets metrics types that are disabled.

@enabled

Boolean

Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

@jvmMetricsEnabled

Boolean

Whether JVM metrics should be collected. Defaults to false.

@labels

Array of 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)

@registryName

String

Set a name for the metrics registry, so that a new registry will be created and associated with this name. If registryName 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.

MongoAuthOptions

Options configuring Mongo authentication.

Name

Type

Description

@collectionName

String

The property name to be used to set the name of the collection inside the config.

@config

Json object

The mongo client configuration: see Mongo Client documentation.

@datasourceName

String

The mongo data source name: see Mongo Client documentation.

@passwordField

String

The property name to be used to set the name of the field, where the password is stored inside

@permissionField

String

The property name to be used to set the name of the field, where the permissions are stored inside.

@roleField

String

The property name to be used to set the name of the field, where the roles are stored inside.

@saltField

String

The property name to be used to set the name of the field, where the SALT is stored inside.

@saltStyle

HashSaltStyle

The property name to be used to set the name of the field, where the salt style is stored inside

@shared

Boolean

Use a shared Mongo client or not.

@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

String

The property name to be used to set the name of the field, where the username is stored inside.

MongoAuthenticationOptions

Options configuring Mongo authentication.

Name

Type

Description

@collectionName

String

The property name to be used to set the name of the collection inside the config.

@passwordCredentialField

String

-

@passwordField

String

The property name to be used to set the name of the field, where the password is stored inside

@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

String

The property name to be used to set the name of the field, where the username is stored inside.

MongoAuthorizationOptions

Options configuring Mongo authentication.

Name

Type

Description

@collectionName

String

The property name to be used to set the name of the collection inside the config.

@permissionField

String

The property name to be used to set the name of the field, where the permissions are stored inside.

@roleField

String

The property name to be used to set the name of the field, where the roles are stored inside.

@usernameField

String

The property name to be used to set the name of the field, where the username is stored inside.

MongoClientBulkWriteResult

Result propagated from mongodb driver bulk write result.

Name

Type

Description

@deletedCount

Number (long)

Returns the number of deleted documents

@insertedCount

Number (long)

Returns the number of inserted documents

@matchedCount

Number (long)

Returns the number of matched documents

@modifiedCount

Number (long)

Returns the number of modified documents

@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

Result propagated from mongodb driver delete result.

Name

Type

Description

@removedCount

Number (long)

Get the number of removed documents

MongoClientUpdateResult

Result propagated from mongodb driver update result.

Name

Type

Description

@docMatched

Number (long)

Get the number of documents that're matched

@docModified

Number (long)

Get the number of documents that're modified

@docUpsertedId

Json object

Get the document id that's upserted

MqttAuth

MQTT authentication information

Name

Type

Description

@password

String

@username

String

MqttClientOptions

Represents options used by the MQTT client.

Name

Type

Description

@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.

The default value of this property is -1 which indicates that the client should wait an unlimited time for the server's acknowledgement.

@autoGeneratedClientId

Boolean

Set if the MQTT client must generate clientId automatically (default is true)

@autoKeepAlive

Boolean

Set if the MQTT client must handle PINGREQ automatically (default is true)

@cleanSession

Boolean

Set to start with a clean session (or not)

@clientId

String

Set the client identifier

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@idleTimeout

Number (int)

Do the same thing as link (int)}. Use it instead.

@idleTimeoutUnit

TimeUnit

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

@keepAliveInterval

Number (int)

Set the keep alive interval in seconds

@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

Boolean

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

@maxInflightQueue

Number (int)

Set max count of unacknowledged messages

@maxMessageSize

Number (int)

Set max MQTT message size

@metricsName

String

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

@password

String

Set the password

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@username

String

Set the username

@willFlag

Boolean

Set if will information are provided on connection

@willMessage

String

Set the content of the will message

@willQoS

Number (int)

Set the QoS level for the will message

@willRetain

Boolean

Set if the will message must be retained

@willTopic

String

Set the topic on which the will message will be published

MqttServerOptions

Represents options used by the MQTT server

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@autoClientId

Boolean

Set if clientid should be auto-generated when it's "zero-bytes"

@clientAuth

ClientAuth

Set whether client auth is required

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Set the host

@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

TimeUnit

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

@logActivity

Boolean

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

@maxMessageSize

Number (int)

Set max MQTT message size

@port

Number (int)

Set the port

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@timeoutOnConnect

Number (int)

Set the timeout on CONNECT packet

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

MqttWill

Will information from the remote MQTT client

Name

Type

Description

@willFlag

Boolean

@willMessage

Buffer

@willQos

Number (int)

@willRetain

Boolean

@willTopic

String

MySQLAuthOptions

Authentication options for MySQL authentication which can be used for CHANGE_USER command.

Name

Type

Description

@charset

String

Set the charset for the connection.

@collation

String

Set the collation for the connection.

@database

String

Specify the default database for the re-authentication.

@password

String

Specify the user password to be used for the authentication.

@properties

String

Set connection attributes which will be sent to server at the re-authentication.

@serverRsaPublicKeyPath

String

Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

@serverRsaPublicKeyValue

Buffer

Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

@user

String

Specify the user account to be used for the authentication.

MySQLConnectOptions

Connect options for configuring link or link.

Name

Type

Description

@cachePreparedStatements

Boolean

Set whether prepared statements cache should be enabled.

@characterEncoding

String

Set the Java charset for encoding string values, this value is UTF-8 by default.

@charset

String

Set the charset for the connection.

@collation

String

Set the collation for the connection.

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@database

String

Specify the default database for the connection.

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Specify the host for connecting to the server.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@password

String

Specify the user password to be used for the authentication.

@port

Number (int)

Specify the port for connecting to the server.

@preparedStatementCacheMaxSize

Number (int)

Set the maximum number of prepared statements that the connection will cache.

@preparedStatementCacheSqlLimit

Number (int)

Set the maximum length of prepared statement SQL string that the connection will cache.

This is an helper setting the link.

@properties

String

Set properties for this client, which will be sent to server at the connection start.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@serverRsaPublicKeyPath

String

Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

@serverRsaPublicKeyValue

Buffer

Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@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

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAffectedRows

Boolean

Sets how affected rows are calculated on update/delete/insert, if set to true an update that effectively does not change any data returns zero affected rows.

See mysql-affected-rows for details.

@useAlpn

Boolean

Set the ALPN usage.

@user

String

Specify the user account to be used for the authentication.

NetClientOptions

Options for configuring a link.

Name

Type

Description

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

NetServerOptions

Options for configuring a link.

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@clientAuth

ClientAuth

Set whether client auth is required

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Set the host

@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

TimeUnit

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

@logActivity

Boolean

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

@port

Number (int)

Set the port

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

NetworkOptions


Name

Type

Description

@logActivity

Boolean

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@trafficClass

Number (int)

Set the value of traffic class

NewTopic

A new topic to be created

Name

Type

Description

@config

String

Set the configuration for the new topic or null if no configs ever specified

@name

String

Set the name of the topic to be created

@numPartitions

Number (int)

Set the number of partitions for the new topic or -1 if a replica assignment has been specified

@replicationFactor

Number (short)

Set the replication factor for the new topic or -1 if a replica assignment has been specified

Node


Name

Type

Description

@address

String

Set node address

@lanAddress

String

Set node lan address

@name

String

Set node name

@wanAddress

String

Set node wan address

Node

Information about a Kafka cluster node

Name

Type

Description

@empty

Boolean

@hasRack

Boolean

Set if this node has a defined rack

@host

String

Set the host name for this node

@id

Number (int)

Set the node id of this node

@idString

String

Set the string representation of the node id

@isEmpty

Boolean

Set if this node is empty

@port

Number (int)

Set the port for this node

@rack

String

Set the rack for this node

NodeList

Holds result of nodes query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested list of nodes

NodeQueryOptions

Options used to requesting list of nodes

Name

Type

Description

@near

String

Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

OAuth2Options

Options describing how an OAuth2 will make connections.

Name

Type

Description

@authorizationPath

String

Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

@clientID

String

Set the provider client id

@clientSecret

String

Set the provider client secret

@clientSecretParameterName

String

Override the HTTP form field name for client secret

@extraParameters

Json object

Set extra parameters to be sent to the provider on each request

@flow

OAuth2FlowType

-

@headers

Json object

Set custom headers to be sent with every request to the provider

@introspectionPath

String

Set the provider token introspection resource path

@jwkPath

String

-

@logoutPath

String

Set the provider logout path

@revocationPath

String

Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

@scopeSeparator

String

Set the provider scope separator

@site

String

Root URL for the provider without trailing slashes

@tenant

String

Sets an optional tenant. Tenants are used in some OpenID servers as placeholders for the URLs. The tenant should be set prior to any URL as it affects the way the URLs will be stored.

Some provders may name this differently, for example: `realm`.

@tokenPath

String

Get the Oauth2 token resource path. e.g.: /oauth/token

@useBasicAuthorizationHeader

Boolean

Flag to use HTTP basic auth header with client id, client secret.

@userAgent

String

Set a custom user agent to use when communicating to a provider

@userInfoParameters

Json object

Set custom parameters to be sent during the userInfo resource request

@userInfoPath

String

Set the provider userInfo resource path

@validateIssuer

Boolean

-

Oauth2Credentials

Credentials specific to the link provider

Name

Type

Description

@code

String

-

@extra

Json object

-

@redirectUri

String

-

OffsetAndMetadata

Provide additional metadata when an offset is committed

Name

Type

Description

@metadata

String

Set additional metadata for the offset committed

@offset

Number (long)

Set the offset to commit

OffsetAndTimestamp

Represent information related to a Offset with timestamp information

Name

Type

Description

@offset

Number (long)

Set the offset

@timestamp

Number (long)

Set the timestamp

OffsetSpec

Name

Type

Description

@spec

Number (long)

Set the offset spec

OpenOptions

Describes how an link should be opened.

Name

Type

Description

@append

Boolean

Whether the file should be opened in append mode. Defaults to false.

@create

Boolean

Set whether the file should be created if it does not already exist.

@createNew

Boolean

Set whether the file should be created and fail if it does exist already.

@deleteOnClose

Boolean

Set whether the file should be deleted when it's closed, or the JVM is shutdown.

@dsync

Boolean

Set whether every write to the file's content ill be written synchronously to the underlying hardware.

@perms

String

Set the permissions string

@read

Boolean

Set whether the file is to be opened for reading

@sparse

Boolean

Set whether a hint should be provided that the file to created is sparse

@sync

Boolean

Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.

@truncateExisting

Boolean

Set whether the file should be truncated to zero length on opening if it exists and is opened for write

@write

Boolean

Set whether the file is to be opened for writing

OpenSSLEngineOptions

Configures a link to use OpenSsl.

Name

Type

Description

@sessionCacheEnabled

Boolean

Set whether session cache is enabled in open SSL session server context

OperationRequest


Name

Type

Description

@extra

Json object

Get extra payload

@params

Json object

Get request parsedParameters as JSON

@user

Json object

Get request principal user as routingContext.user().principal(), null if no user is authenticated

OperationResponse


Name

Type

Description

@payload

Buffer

-

@statusCode

Number (Integer)

-

@statusMessage

String

-

Option

Models command line options. Options are values passed to a command line interface using -x or --x. Supported syntaxes depend on the parser.

Short name is generally used with a single dash, while long name requires a double-dash.


Name

Type

Description

@argName

String

Sets te arg name for this option.

@choices

Array of String

Sets the list of values accepted by this option. If the value set by the user does not match once of these values, a link exception is thrown.

@defaultValue

String

Sets the default value of this option

@description

String

Sets te description of this option.

@flag

Boolean

Configures the current link to be a flag. It will be evaluated to true if it's found in the command line. If you need a flag that may receive a value, use, in this order:

  option.setFlag(true).setSingleValued(true)

@help

Boolean

Sets whether or not this option is a "help" option

@hidden

Boolean

Sets whether or not this option should be hidden

@longName

String

Sets the long name of this option.

@multiValued

Boolean

Sets whether or not this option can receive several values.

@name

String

@required

Boolean

Sets whether or not this option is mandatory.

@shortName

String

Sets the short name of this option.

@singleValued

Boolean

Sets whether or not this option can receive a value.

PartitionInfo

Information about a specific Kafka topic partition

Name

Type

Description

@partition

Number (int)

Set the partition id

@topic

String

Set the topic name

PemKeyCertOptions

Key store options configuring a list of private key and its certificate based on Privacy-enhanced Electronic Email (PEM) files.

A key file must contain a non encrypted private key in PKCS8 format wrapped in a PEM block, for example:

-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDV6zPk5WqLwS0a
...
K5xBhtm1AhdnZjx5KfW3BecE
-----END PRIVATE KEY-----

Or contain a non encrypted private key in PKCS1 format wrapped in a PEM block, for example:

-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAlO4gbHeFb/fmbUF/tOJfNPJumJUEqgzAzx8MBXv9Acyw9IRa
...
zJ14Yd+t2fsLYVs2H0gxaA4DW6neCzgY3eKpSU0EBHUCFSXp/1+/
-----END RSA PRIVATE KEY-----

A certificate file must contain an X.509 certificate wrapped in a PEM block, for example:

-----BEGIN CERTIFICATE-----
MIIDezCCAmOgAwIBAgIEZOI/3TANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV
...
+tmLSvYS39O2nqIzzAUfztkYnUlZmB0l/mKkVqbGJA==
-----END CERTIFICATE-----
Keys and certificates can either be loaded by Vert.x from the filesystem:

HttpServerOptions options = new HttpServerOptions();
options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyPath("/mykey.pem").setCertPath("/mycert.pem"));
Or directly provided as a buffer:

Buffer key = vertx.fileSystem().readFileBlocking("/mykey.pem");
Buffer cert = vertx.fileSystem().readFileBlocking("/mycert.pem");
options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyValue(key).setCertValue(cert));
Several key/certificate pairs can be used:

HttpServerOptions options = new HttpServerOptions();
options.setPemKeyCertOptions(new PemKeyCertOptions()
   .addKeyPath("/mykey1.pem").addCertPath("/mycert1.pem")
   .addKeyPath("/mykey2.pem").addCertPath("/mycert2.pem"));

Name

Type

Description

@certPath

String

Set the path of the first certificate, replacing the previous certificates paths

@certPaths

Array of String

Set all the paths to the certificates files

@certValue

Buffer

Set the first certificate as a buffer, replacing the previous certificates buffers

@certValues

Array of Buffer

Set all the certificates as a list of buffer

@keyPath

String

Set the path of the first key file, replacing the keys paths

@keyPaths

Array of String

Set all the paths to the keys files

@keyValue

Buffer

Set the first key a a buffer, replacing the previous keys buffers

@keyValues

Array of Buffer

Set all the keys as a list of buffer

PemTrustOptions

Certificate Authority options configuring certificates based on Privacy-enhanced Electronic Email (PEM) files. The options is configured with a list of validating certificates.

Validating certificates must contain X.509 certificates wrapped in a PEM block:

-----BEGIN CERTIFICATE-----
MIIDezCCAmOgAwIBAgIEVmLkwTANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV
...
z5+DuODBJUQst141Jmgq8bS543IU/5apcKQeGNxEyQ==
-----END CERTIFICATE-----
The certificates can either be loaded by Vert.x from the filesystem:

HttpServerOptions options = new HttpServerOptions();
options.setPemTrustOptions(new PemTrustOptions().addCertPath("/cert.pem"));
Or directly provided as a buffer:

Buffer cert = vertx.fileSystem().readFileBlocking("/cert.pem");
HttpServerOptions options = new HttpServerOptions();
options.setPemTrustOptions(new PemTrustOptions().addCertValue(cert));

Name

Type

Description

@certPaths

Array of String

Add a certificate path

@certValues

Array of Buffer

Add a certificate value

PermittedOptions

Represents a match to allow for inbound and outbound traffic.

Name

Type

Description

@address

String

The exact address the message is being sent to. If you want to allow messages based on an exact address you use this field.

@addressRegex

String

A regular expression that will be matched against the address. If you want to allow messages based on a regular expression you use this field. If the link value is specified this will be ignored.

@match

Json object

This allows you to allow messages based on their structure. Any fields in the match must exist in the message with the same values for them to be allowed. This currently only works with JSON messages.

@requiredAuthority

String

Declare a specific authority that user must have in order to allow messages

PfxOptions

Key or trust store options configuring private key and/or certificates based on PKCS#12 files.

Name

Type

Description

@password

String

Set the password for the key store

@path

String

Set the path to the key store

@type

String

-

@value

Buffer

Set the key store as a buffer

PgConnectOptions


Name

Type

Description

@cachePreparedStatements

Boolean

Set whether prepared statements cache should be enabled.

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@database

String

Specify the default database for the connection.

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Specify the host for connecting to the server.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@password

String

Specify the user password to be used for the authentication.

@pipeliningLimit

Number (int)

-

@port

Number (int)

Specify the port for connecting to the server.

@preparedStatementCacheMaxSize

Number (int)

Set the maximum number of prepared statements that the connection will cache.

@preparedStatementCacheSqlLimit

Number (int)

Set the maximum length of prepared statement SQL string that the connection will cache.

This is an helper setting the link.

@properties

String

Set properties for this client, which will be sent to server at the connection start.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@sslMode

SslMode

Set link for the client, this option can be used to provide different levels of secure protection.

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@user

String

Specify the user account to be used for the authentication.

@usingDomainSocket

Boolean

-

PgNotification

A notification emited by Postgres.

Name

Type

Description

@channel

String

Set the channel value.

@payload

String

Set the payload value.

@processId

Number (int)

Set the process id.

PoolOptions

The options for configuring a connection pool.

Name

Type

Description

@maxSize

Number (int)

Set the maximum pool size

@maxWaitQueueSize

Number (int)

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

PreparedQueryDefinition

Defines a prepared query.

Name

Type

Description

@dcs

Array of String

Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters. A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN and is listed in Datacenters.

@dnsTtl

String

Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

@id

String

Set ID of the query, always generated by Consul

@meta

String

Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

@name

String

Set an optional friendly name that can be used to execute a query instead of using its ID

@nearestN

Number (int)

Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server handling the query to the servers in the remote datacenter is used to determine the priority.

@passing

Boolean

Specifies the behavior of the query's health check filtering. If this is set to false, the results will include nodes with checks in the passing as well as the warning states. If this is set to true, only nodes with checks in the passing state will be returned.

@service

String

Set the name of the service to query

@session

String

Set the ID of an existing session. This provides a way to automatically remove a prepared query when the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.

@tags

Array of String

Set a list of service tags to filter the query results. For a service to pass the tag filter it must have all of the required tags, and none of the excluded tags (prefixed with `!`).

@templateRegexp

String

Set regular expression which is used to extract fields from the entire name, once this template is selected.

@templateType

String

The template type, which must be name_prefix_match. This means that the template will apply to any query lookup with a name whose prefix matches the Name field of the template.

@token

String

Set the ACL token to use each time the query is executed. This allows queries to be executed by clients with lesser or even no ACL Token, so this should be used with care.

PreparedQueryExecuteOptions

Options used to execute prepared query

Name

Type

Description

@limit

Number (int)

Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

@near

String

Set node name for sorting the list in ascending order based on the estimated round trip time from that node. Passing _agent will use the agent's node for the sort. If this is not present, the default behavior will shuffle the nodes randomly each time the query is executed.

PreparedQueryExecuteResponse

The results of executing prepared query

Name

Type

Description

@dc

String

Set the datacenter that ultimately provided the list of nodes

@dnsTtl

String

Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

@failovers

Number (int)

Set the number of remote datacenters that were queried while executing the query.

@service

String

Set the service name that the query was selecting. This is useful for context in case an empty list of nodes is returned.

ProxyOptions

Proxy options for a net client or a net client.

Name

Type

Description

@host

String

Set proxy host.

@password

String

Set proxy password.

@port

Number (int)

Set proxy port.

@type

ProxyType

Set proxy type.

ProxyType can be HTTP, SOCKS4 and SOCKS5

@username

String

Set proxy username.

PubSecKeyOptions

Options describing Key stored in PEM format.

Name

Type

Description

@algorithm

String

-

@buffer

String

The PEM or Secret key buffer

@certificate

Boolean

-

@id

String

-

@publicKey

String

@secretKey

String

@symmetric

Boolean

-

Record

Describes a `service`. The record is the only piece of information shared between consumer and provider. It should contains enough metadata to let consumer find the service they want.

Name

Type

Description

@location

Json object

Sets the json object describing the location of the service. By convention, this json object should contain the link entry.

@metadata

Json object

Gets the metadata attached to the record.

@name

String

Sets the name of the service. It can reflect the service name of the name of the provider.

@registration

String

Sets the registration id. This method is called when the service is published.

@status

Status

Sets the status of the service. When published, the status is set to. When withdrawn, the status is set to .

@type

String

Sets the type of service.

RecordMetadata

Metadata related to a Kafka record

Name

Type

Description

@checksum

Number (long)

Set the checksum (CRC32) of the record.

@offset

Number (long)

Set the offset of the record in the topic/partition.

@partition

Number (int)

Set the partition the record was sent to

@timestamp

Number (long)

Set the timestamp of the record in the topic/partition

@topic

String

Set the topic the record was appended to

RedisOptions

Redis Client Configuration options.

Name

Type

Description

@connectionString

String

Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings.

@connectionStrings

Array of String

Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

@endpoint

String

Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings.

@endpoints

Array of String

Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

@masterName

String

Set the master name (only considered in HA mode).

@maxNestedArrays

Number (int)

Tune how much nested arrays are allowed on a redis response. This affects the parser performance.

@maxPoolSize

Number (int)

Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)

@maxPoolWaiting

Number (int)

Tune the maximum waiting requests for a connection from the pool.

@maxWaitingHandlers

Number (int)

The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.

@password

String

Set the default password for cluster/sentinel connections.

@poolCleanerInterval

Number (int)

Tune how often in milliseconds should the connection pool cleaner execute.

@poolRecycleTimeout

Number (int)

Tune when a connection should be recycled in milliseconds.

@role

RedisRole

Set the role name (only considered in HA mode).

@type

RedisClientType

Set the desired client type to be created.

@useReplicas

RedisReplicas

Set whether or not to use replica nodes (only considered in Cluster mode).

RelyingParty

Data object representing a Relying party (your server)

Name

Type

Description

@icon

String

-

@id

String

-

@name

String

-

ReportOptions

Configures a reporter consisting in a name to, an address at and an optional format.

Name

Type

Description

@format

String

Set the current reporter format.

@to

String

Set the current reporter name.

ReportingOptions

Reporting options:
  • the reporters is an array of reporter configurations

Name

Type

Description

RequestOptions

Options describing how an link will connect to make a request.

Name

Type

Description

@absoluteURI

String

Parse an absolute URI to use, this will update the ssl, host, port and uri fields.

@followRedirects

Boolean

Set whether to follow HTTP redirect

@headers

String

Add a request header.

@host

String

Set the host name to be used by the client request.

@port

Number (Integer)

Set the port to be used by the client request.

@ssl

Boolean

Set whether SSL/TLS is enabled.

@timeout

Number (long)

Sets the amount of time after which if the request does not return any data within the timeout period an link will be passed to the exception handler and the request will be closed.

@uri

String

Set the request relative URI.

ResultSet

Represents the results of a SQL query.

It contains a list for the column names of the results, and a list of JsonArray - one for each row of the results.


Name

Type

Description

@columnNames

Array of String

Get the column names

@numColumns

Number (int)

Return the number of columns in the result set

@numRows

Number (int)

Return the number of rows in the result set

@output

Json array

Get the registered outputs

@results

Array of Json array

Get the results

@rows

Array of Json object

Get the rows - each row represented as a JsonObject where the keys are the column names and the values are the column values.

Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will overwrite the other if using this method. If that's the case use link instead.

Be aware that column names are defined as returned by the database, this means that even if your SQL statement is for example:

SELECT a, b FROM table
the column names are not required to be:
a
and
b
and could be in fact
A
and
B
.

For cases when there is the need for case insentivitity you should see link

RouterFactoryOptions


Name

Type

Description

@mountNotImplementedHandler

Boolean

If true, Router Factory will automatically mount an handler that return HTTP 405/501 status code for each operation where you didn't specify an handler. You can customize the response with link

@mountResponseContentTypeHandler

Boolean

If true, when required, the factory will mount a link

@mountValidationFailureHandler

Boolean

Enable or disable validation failure handler. If you enable it during router creation a failure handler that manages ValidationException will be mounted. You can change the validation failure handler with with function link. If failure is different from ValidationException, next failure handler will be called.

@operationModelKey

String

When set, an additional handler will be created to expose the operation model in the routing context under the given key. When the key is null, the handler is not added.

@requireSecurityHandlers

Boolean

If true, when you call link the factory will mount for every path the required security handlers and, if a security handler is not defined, it throws an link

SQLOptions

Represents the options one can use to customize the unwrapped connection/statement/resultset types

Name

Type

Description

@autoGeneratedKeys

Boolean

-

@autoGeneratedKeysIndexes

Json array

-

@catalog

String

-

@fetchDirection

FetchDirection

-

@fetchSize

Number (int)

-

@maxRows

Number (int)

-

@queryTimeout

Number (int)

-

@readOnly

Boolean

-

@resultSetConcurrency

ResultSetConcurrency

-

@resultSetType

ResultSetType

-

@schema

String

-

@transactionIsolation

TransactionIsolation

-

SSHTermOptions

The SSH term configuration options.

Name

Type

Description

@authOptions

Json object

Set the auth options.

@defaultCharset

String

Set the default charset to use when the client does not specifies one.

@host

String

Set the host

@intputrc

String

The path of the inputrc config.

@port

Number (int)

Set the port

SchemaRouterOptions

Represents the options to resolve external schemas. You can configure auth options to access to external services

Name

Type

Description

@authHeaders

String

-

@authQueryParams

String

-

Service

Holds properties of service and node that its containing

Name

Type

Description

@address

String

Set service address

@id

String

Set ID of service

@meta

String

Specifies arbitrary KV metadata linked to the service instance.

@name

String

Set service name

@node

String

Set node name

@nodeAddress

String

Set node address

@port

Number (int)

Set service port

@tags

Array of String

Set list of service tags

ServiceDiscoveryOptions

Options to configure the service discovery.

Name

Type

Description

@announceAddress

String

Sets the event bus address on which the service arrivals, departures and modifications are announced. This address must be consistent in the whole application.

@autoRegistrationOfImporters

Boolean

Sets whether or not the registration of importers declared as SPI is enabled.

@backendConfiguration

Json object

Sets the configuration passed to the . Refer to the backend documentation to get more details on the requirements. The default backend does not need any configuration.

@name

String

Sets the service discovery name used in the service usage events. If not set, the node id is used.

@usageAddress

String

Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

ServiceEntry

Holds properties of service, node and related checks

Name

Type

Description

ServiceEntryList

Holds list of services, nodes and related checks

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested list of services

ServiceList

Holds result of services query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested list of services

ServiceOptions

Options used to register service.

Name

Type

Description

@address

String

Set service address

@id

String

Set the ID of session

@meta

String

Specifies arbitrary KV metadata linked to the service instance.

@name

String

Set service name

@port

Number (int)

Set service port

@tags

Array of String

Set list of tags associated with service

ServiceQueryOptions

Options used to requesting list of services

Name

Type

Description

@near

String

Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

@tag

String

Set tag for filtering request results

Session

Holds properties of Consul sessions

Name

Type

Description

@checks

Array of String

Set the list of associated health checks

@createIndex

Number (long)

Set the create index of session

@id

String

Set the ID of node

@index

Number (long)

Set Consul index

@lockDelay

Number (long)

Set the Lock delay of session

@node

String

Set the ID of node

SessionList

Holds result of sessions query

Name

Type

Description

@index

Number (long)

Set Consul index, a unique identifier representing the current state of the requested list of sessions

SessionOptions

Options used to create session.

Name

Type

Description

@behavior

SessionBehavior

Set the behavior when a session is invalidated. The release behavior is the default if none is specified.

@checks

Array of String

Set a list of associated health checks. It is highly recommended that, if you override this list, you include the default "serfHealth"

@lockDelay

Number (long)

Set the lock-delay period.

@name

String

Set the human-readable name for the Session

@node

String

Set the node to which the session will be assigned

@ttl

Number (long)

Set the TTL interval. When TTL interval expires without being renewed, the session has expired and an invalidation is triggered. If specified, it must be between 10s and 86400s currently.

The contract of a TTL is that it represents a lower bound for invalidation; that is, Consul will not expire the session before the TTL is reached, but it is allowed to delay the expiration past the TTL.

The lowest practical TTL should be used to keep the number of managed sessions low. When locks are forcibly expired, such as during a leader election, sessions may not be reaped for up to double this TTL, so long TTL values (> 1 hour) should be avoided.

ShellServerOptions

The configurations options for the shell server.

Name

Type

Description

@reaperInterval

Number (long)

Set the repear interval, i.e the period at which session eviction is performed.

@sessionTimeout

Number (long)

Set the session timeout.

@welcomeMessage

String

Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

ShellServiceOptions

The configurations options for the shell service, the shell connectors can be configured with , and .

Name

Type

Description

@reaperInterval

Number (long)

Set the repear interval, i.e the period at which session eviction is performed.

@sessionTimeout

Number (long)

Set the session timeout.

@welcomeMessage

String

Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

ShiroAuthOptions

Shiro auth configuration options, see Vert.x Auth Shiro component and/or Apache Shiro project.

Name

Type

Description

@config

Json object

Set the Shiro auth config.

@type

ShiroAuthRealmType

Set the Shiro auth options type.

SockJSBridgeOptions

Options for configuring the event bus bridge.

Name

Type

Description

@maxAddressLength

Number (int)

-

@maxHandlersPerSocket

Number (int)

-

@pingTimeout

Number (long)

-

@replyTimeout

Number (long)

-

SockJSHandlerOptions

Options for configuring a SockJS handler

Name

Type

Description

@disabledTransports

Array of String

Add a transport (by name) to the set of disabled transports.

@heartbeatInterval

Number (long)

In order to keep proxies and load balancers from closing long running HTTP requests we need to pretend that the connection is active and send a heartbeat packet once in a while. This setting controls how often this is done.

Defaults to 25 seconds.

@insertJSESSIONID

Boolean

Whether to insert a JSESSIONID cookie so load-balancers ensure requests for a specific SockJS session are always routed to the correct server.

Defaults to true.

@libraryURL

String

Transports which don't support cross-domain communication natively use an iframe trick. A simple page is served from the SockJS server (using its foreign domain) and is placed in an invisible iframe.

Code run from this iframe doesn't need to worry about cross-domain issues, as it's being run from domain local to the SockJS server. This iframe also does need to load SockJS javascript client library, and this option lets you specify its URL.

@localWriteHandler

Boolean

Whether the writeHandler should be local only or cluster-wide.

Defaults to true.

@maxBytesStreaming

Number (int)

Most streaming transports save responses on the client side and don't free memory used by delivered messages. Such transports need to be garbage-collected once in a while.

This setting controls the maximum number of bytes that can be sent over a single HTTP streaming request before it will be closed. After that the client needs to open new request. Setting this value to one effectively disables streaming and will make streaming transports to behave like polling transports.

Defaults to 128K.

@registerWriteHandler

Boolean

Whether a writeHandler should be registered on the link.

Defaults to false.

@sessionTimeout

Number (long)

Set the delay before the server sends a close event when a client receiving connection has not been seen for a while.

Defaults to 5 seconds.

SqlAuthenticationOptions

Options configuring JDBC authentication.

Name

Type

Description

@authenticationQuery

String

Set the authentication query to use. Use this if you want to override the default authentication query.

SqlAuthorizationOptions

Options configuring JDBC authentication.

Name

Type

Description

@permissionsQuery

String

Set the permissions query to use. Use this if you want to override the default permissions query.

@rolesQuery

String

Set the roles query to use. Use this if you want to override the default roles query.

SqlConnectOptions

Connect options for configuring link or link.

Name

Type

Description

@cachePreparedStatements

Boolean

Set whether prepared statements cache should be enabled.

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@database

String

Specify the default database for the connection.

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Specify the host for connecting to the server.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@metricsName

String

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

@password

String

Specify the user password to be used for the authentication.

@port

Number (int)

Specify the port for connecting to the server.

@preparedStatementCacheMaxSize

Number (int)

Set the maximum number of prepared statements that the connection will cache.

@preparedStatementCacheSqlLimit

Number (int)

Set the maximum length of prepared statement SQL string that the connection will cache.

This is an helper setting the link.

@properties

String

Set properties for this client, which will be sent to server at the connection start.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@user

String

Specify the user account to be used for the authentication.

Status

Represents the outcome of a health check procedure. Each procedure produces a link indicating either OK or KO. Optionally, it can also provide additional data.

Name

Type

Description

@data

Json object

Sets the metadata.

@ok

Boolean

Sets whether or not the current status is positive (UP) or negative (DOWN).

@procedureInError

Boolean

Sets whether or not the procedure attached to this status has failed (timeout, error...).

StompClientOptions

Options used to configure a STOMP client. As a STOMP client wraps a Net client, you can also configure the underlying NET client.

Name

Type

Description

@acceptedVersions

Array of String

Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest version to the highest. By default the following list is used: 1.0, 1.1, 1.2

@autoComputeContentLength

Boolean

Sets whether or not the automatic computation of the content-length header is enabled. If enabled, the content-length header is set in all frame with a body that do not explicitly set the header. The option is enabled by default.

@bypassHostHeader

Boolean

Sets whether or not the host header must be dropped from the CONNECT/STOMP frame. Server may be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@heartbeat

Json object

Sets the heartbeat configuration.

@host

String

Sets the STOMP server host. 0.0.0.0 by default.

@hostnameVerificationAlgorithm

String

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

@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

TimeUnit

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

@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

Boolean

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

@login

String

Sets the login to use if the STOMP server is secured.

@metricsName

String

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

@passcode

String

Sets the passcode to use if the STOMP server is secured.

@port

Number (int)

Sets the STOMP server port. 61613 by default.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reconnectAttempts

Number (int)

Set the value of reconnect attempts

@reconnectInterval

Number (long)

Set the reconnect interval

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@trailingLine

Boolean

Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

@trustAll

Boolean

Set whether all server certificates should be trusted

@useAlpn

Boolean

Set the ALPN usage.

@useStompFrame

Boolean

Sets whether or not the connection is made using the STOMP command instead of the CONNECT command. The STOMP command has been introduced in the 1.2 version of the protocol to ease the network analysis (as CONNECT is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled. This option is disabled by default.

@virtualHost

String

Sets the virtual host that will be used as "host" header value in the `CONNECT` frame.

StompServerOptions

STOMP Server options. You can also configure the Net Server used by the STOMP server from these options.

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@clientAuth

ClientAuth

Set whether client auth is required

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@heartbeat

Json object

Sets the heartbeat configuration.

@host

String

Set the host

@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

TimeUnit

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

@logActivity

Boolean

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

@maxBodyLength

Number (int)

Sets the max body length accepted by the server. 10 Mb by default.

@maxFrameInTransaction

Number (int)

Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a transaction exceeds this threshold, the client receives an ERROR frame and is disconnected. The default is 1000.

@maxHeaderLength

Number (int)

Sets the max header length.

@maxHeaders

Number (int)

Sets the maximum number of headers. 1000 by default.

@maxSubscriptionsByClient

Number (int)

Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives an error and the connection is closed.

@port

Number (int)

Sets the port on which the server is going to listen for TCP connection.

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@secured

Boolean

Enables or disables the server security feature. It requires an link handler.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@sendErrorOnNoSubscriptions

Boolean

Sets whether or not an error is sent to the client when this client sends a message to an not subscribed destinations (no subscriptions on this destination).

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@supportedVersions

Array of String

Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@timeFactor

Number (int)

Sets the time factor.

@trafficClass

Number (int)

Set the value of traffic class

@trailingLine

Boolean

Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

@transactionChunkSize

Number (int)

Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large transactions are split into chunks, replayed one by one. This settings sets the chunk size.

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

@websocketBridge

Boolean

Enables or disables the web socket bridge.

@websocketPath

String

Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

StreamPriority

This class represents HTTP/2 stream priority defined in RFC 7540 clause 5.3

Name

Type

Description

@dependency

Number (int)

Set the priority dependency value.

@exclusive

Boolean

Set the priority exclusive value.

@weight

Number (short)

Set the priority weight.

TCPSSLOptions

Base class. TCP and SSL related options

Name

Type

Description

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@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

TimeUnit

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

@logActivity

Boolean

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

TelnetTermOptions

Telnet terminal options configuration, extends link.

Name

Type

Description

@acceptBacklog

Number (int)

Set the accept back log

@charset

String

Set the charset to use when binary mode is active, see link and link.

@clientAuth

ClientAuth

Set whether client auth is required

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@host

String

Set the host

@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

TimeUnit

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

@inBinary

Boolean

Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.

@intputrc

String

The path of the inputrc config.

@logActivity

Boolean

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

@outBinary

Boolean

Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.

@port

Number (int)

Set the port

@proxyProtocolTimeout

Number (long)

Set the Proxy protocol timeout, default time unit is seconds.

@proxyProtocolTimeoutUnit

TimeUnit

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

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@sni

Boolean

Set whether the server supports Server Name Indiciation

@soLinger

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@trafficClass

Number (int)

Set the value of traffic class

@useAlpn

Boolean

Set the ALPN usage.

@useProxyProtocol

Boolean

Set whether the server uses the HA Proxy protocol

TestOptions

Test execution options:
  • the timeout in milliseconds, the default value is 2 minutes
  • the useEventLoop
  • configures the event loop usage
    • true always runs with an event loop
    • false never runs with an event loop
    • null uses an event loop if there is one (provided by link) otherwise run without
  • the reporters is an array of reporter configurations

Name

Type

Description

@timeout

Number (long)

Set the test timeout.

@useEventLoop

Boolean

Configure the execution to use an event loop when there is no one existing.

TokenCredentials

Credentials used by any link that requires Tokens, such as OAuth2 or JWT to perform its authentication

Name

Type

Description

@token

String

-

TopicDescription

A detailed description of a single topic in the cluster

Name

Type

Description

@internal

Boolean

Set whether the topic is internal to Kafka.

@name

String

Set the name of the topic.

TopicPartition

Represent information related to a partition for a topic

Name

Type

Description

@partition

Number (int)

Set the partition number

@topic

String

Set the topic name

TopicPartitionInfo

A class containing leadership, replicas and ISR information for a topic partition.

Name

Type

Description

@partition

Number (int)

Set the partition id

TracingOptions

Vert.x tracing base configuration, this class can be extended by provider implementations to configure those specific implementations.

Name

Type

Description

TxnError

Holds information describing which operations failed if the transaction was rolled back.

Name

Type

Description

@opIndex

Number (int)

Set the index of the failed operation in the transaction

@what

String

Set error message about why that operation failed.

TxnKVOperation

Holds operation to apply to the key/value store inside a transaction

Name

Type

Description

@flags

Number (long)

Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

@index

Number (long)

Set the index used for locking, unlocking, and check-and-set operations.

@key

String

Set the key

@session

String

Set the session used for locking, unlocking, and check-and-set operations.

@type

TxnKVVerb

Set the type of operation to perform

@value

String

Set the value

TxnRequest

Holds list of operations in transaction

Name

Type

Description

@operationsSize

Number (int)

Returns the number of operations in this request

TxnResponse

Holds results of transaction

Name

Type

Description

@errorsSize

Number (int)

Returns the number of errors in this response

@resultsSize

Number (int)

Returns the number of results in this response

UpdateOptions

Options for configuring updates.

Name

Type

Description

@arrayFilters

Json array

Set the arrayFilters option

@multi

Boolean

Set whether multi is enabled

@returningNewDocument

Boolean

Set whether new document property is enabled. Valid only on findOneAnd* methods.

@upsert

Boolean

Set whether upsert is enabled

@writeOption

WriteOption

Set the write option

UpdateResult

Represents the result of an update/insert/delete operation on the database.

The number of rows updated is available with link and any generated keys are available with link.


Name

Type

Description

@keys

Json array

Get any generated keys

@updated

Number (int)

Get the number of rows updated

UsernamePasswordCredentials

Credentials used by any link that requires tokens, for example JWT, Oauth2, OpenId Connect

Name

Type

Description

@password

String

-

@username

String

-

VertxInfluxDbOptions

Vert.x InfluxDb micrometer configuration.

Name

Type

Description

@batchSize

Number (int)

Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. Default is 10000.

@compressed

Boolean

Activate or deactivate GZIP compression. It is activated by default.

@connectTimeout

Number (int)

Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

@db

String

Database name used to store metrics. Default is "default".

@enabled

Boolean

Set true to enable InfluxDB reporting

@numThreads

Number (int)

Number of threads to use by the push scheduler. Default is 2.

@password

String

Password used for authenticated connections

@readTimeout

Number (int)

Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

@retentionPolicy

String

InfluxDB retention policy

@step

Number (int)

Push interval steps, in seconds. Default is 10 seconds.

@uri

String

URI of the InfluxDB server. Example: http://influx:8086.

@userName

String

Username used for authenticated connections

VertxJmxMetricsOptions

Options for Prometheus metrics backend.

Name

Type

Description

@domain

String

Set the JMX domain under which to publish metrics

@enabled

Boolean

Set true to enable Prometheus reporting

@step

Number (int)

Push interval steps, in seconds. Default is 10 seconds.

VertxOptions

Instances of this class are used to configure link instances.

Name

Type

Description

@blockedThreadCheckInterval

Number (long)

Sets the value of blocked thread check period, in link.

The default value of link is

@blockedThreadCheckIntervalUnit

TimeUnit

Set the time unit of blockedThreadCheckInterval.

@eventLoopPoolSize

Number (int)

Set the number of event loop threads to be used by the Vert.x instance.

@haEnabled

Boolean

Set whether HA will be enabled on the Vert.x instance.

@haGroup

String

Set the HA group to be used when HA is enabled.

@internalBlockingPoolSize

Number (int)

Set the value of internal blocking pool size

@maxEventLoopExecuteTime

Number (long)

Sets the value of max event loop execute time, in link.

The default value of linkis

@maxEventLoopExecuteTimeUnit

TimeUnit

Set the time unit of maxEventLoopExecuteTime.

@maxWorkerExecuteTime

Number (long)

Sets the value of max worker execute time, in link.

The default value of link is

@maxWorkerExecuteTimeUnit

TimeUnit

Set the time unit of maxWorkerExecuteTime.

@preferNativeTransport

Boolean

Set wether to prefer the native transport to the JDK transport.

@quorumSize

Number (int)

Set the quorum size to be used when HA is enabled.

@warningExceptionTime

Number (long)

Set the threshold value above this, the blocked warning contains a stack trace. in link. The default value of link is

@warningExceptionTimeUnit

TimeUnit

Set the time unit of warningExceptionTime.

@workerPoolSize

Number (int)

Set the maximum number of worker threads to be used by the Vert.x instance.

VertxPrometheusOptions

Options for Prometheus metrics backend.

Name

Type

Description

@embeddedServerEndpoint

String

Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

@enabled

Boolean

Set true to enable Prometheus reporting

@publishQuantiles

Boolean

Set true to publish histogram stats, necessary to compute quantiles. Note that it generates many new timeseries for stats, which is why it is deactivated by default.

@startEmbeddedServer

Boolean

When true, an embedded server will init to expose metrics with Prometheus format.

WebAuthnCredentials

Name

Type

Description

@challenge

String

-

@domain

String

-

@origin

String

-

@username

String

-

@webauthn

Json object

-

WebAuthnOptions

Configuration for the webauthn object

Name

Type

Description

@attestation

Attestation

-

@authenticatorAttachment

AuthenticatorAttachment

-

@challengeLength

Number (int)

-

@extensions

Json object

-

@pubKeyCredParams

Array of PublicKeyCredential

-

@requireResidentKey

Boolean

-

@rootCertificates

String

-

@rootCrls

Array of String

-

@timeout

Number (Long)

-

@transports

Array of AuthenticatorTransport

-

@userVerification

UserVerification

-

WebClientOptions


Name

Type

Description

@alpnVersions

Array of 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:

  • : [ "h2", "http/1.1" ]
  • otherwise: [link]

@connectTimeout

Number (int)

Set the connect timeout

@crlPaths

Array of String

Add a CRL path

@crlValues

Array of Buffer

Add a CRL value

@decoderInitialBufferSize

Number (int)

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

@defaultHost

String

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

@defaultPort

Number (int)

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

@enabledCipherSuites

Array of String

Add an enabled cipher suite, appended to the ordered suites.

@enabledSecureTransportProtocols

Array of String

Sets the list of enabled SSL/TLS protocols.

@followRedirects

Boolean

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

@forceSni

Boolean

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

@http2ClearTextUpgrade

Boolean

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

@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.

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

@http2KeepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@http2MaxPoolSize

Number (int)

Set the maximum pool size for HTTP/2 connections

@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.

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

@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

TimeUnit

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

@keepAlive

Boolean

Set whether keep alive is enabled on the client

@keepAliveTimeout

Number (int)

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

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

A timeout of 0 means there is no timeout.

@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

Boolean

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

@maxChunkSize

Number (int)

Set the maximum HTTP chunk size

@maxHeaderSize

Number (int)

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

@maxInitialLineLength

Number (int)

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

@maxPoolSize

Number (int)

Set the maximum pool size for connections

@maxRedirects

Number (int)

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

@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

Number (int)

Set the max WebSocket frame size

@maxWebSocketMessageSize

Number (int)

Set the max WebSocket message size

@metricsName

String

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

@pipelining

Boolean

Set whether pipe-lining is enabled on the client

@pipeliningLimit

Number (int)

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

@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

HttpVersion

Set the protocol version.

@receiveBufferSize

Number (int)

Set the TCP receive buffer size

@reuseAddress

Boolean

Set the value of reuse address

@reusePort

Boolean

Set the value of reuse port.

This is only supported by native transports.

@sendBufferSize

Number (int)

Set the TCP send buffer size

@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

Number (int)

Set whether SO_linger keep alive is enabled

@ssl

Boolean

Set whether SSL/TLS is enabled

@sslHandshakeTimeout

Number (long)

Set the SSL handshake timeout, default time unit is seconds.

@sslHandshakeTimeoutUnit

TimeUnit

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

@tcpCork

Boolean

Enable the TCP_CORK option - only with linux native transport.

@tcpFastOpen

Boolean

Enable the TCP_FASTOPEN option - only with linux native transport.

@tcpKeepAlive

Boolean

Set whether TCP keep alive is enabled

@tcpNoDelay

Boolean

Set whether TCP no delay is enabled

@tcpQuickAck

Boolean

Enable the TCP_QUICKACK option - only with linux native transport.

@tracingPolicy

TracingPolicy

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

@trafficClass

Number (int)

Set the value of traffic class

@trustAll

Boolean

Set whether all server certificates should be trusted

@tryUseCompression

Boolean

Set whether compression is enabled

@tryUsePerFrameWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-frame deflate compression extension.

@tryUsePerMessageWebSocketCompression

Boolean

Set whether the client will offer the WebSocket per-message deflate compression extension.

@tryWebSocketDeflateFrameCompression

Boolean

@useAlpn

Boolean

Set the ALPN usage.

@userAgent

String

Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

@userAgentEnabled

Boolean

Sets whether the Web Client should send a user agent header. Defaults to true.

@verifyHost

Boolean

Set whether hostname verification is enabled

@webSocketClosingTimeout

Number (int)

Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.

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.

Set 0L or a negative value to disable.

@webSocketCompressionAllowClientNoContext

Boolean

Set whether the client_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

@webSocketCompressionLevel

Number (int)

Set the WebSocket deflate compression level.

@webSocketCompressionRequestServerNoContext

Boolean

Set whether the server_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

WebSocketConnectOptions

Options describing how an link connect a link.

Name

Type

Description

@absoluteURI

String

Parse an absolute URI to use, this will update the ssl, host, port and uri fields.

@followRedirects

Boolean

Set whether to follow HTTP redirect

@headers

String

Add a request header.

@host

String

Set the host name to be used by the client request.

@port

Number (Integer)

Set the port to be used by the client request.

@ssl

Boolean

Set whether SSL/TLS is enabled.

@subProtocols

Array of String

Set the WebSocket sub protocols to use.

@timeout

Number (long)

Sets the amount of time after which if the request does not return any data within the timeout period an link will be passed to the exception handler and the request will be closed.

@uri

String

Set the request relative URI.

@version

WebsocketVersion

Set the WebSocket version.