AclToken
Name |
Type |
Description |
|
Set ID of token |
|
|
Set name of token |
|
|
Set rules for token |
|
Set type of token |
AddressResolverOptions
Name |
Type |
Description |
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Set the maximum number of queries when an hostname is resolved. |
|
|
Set the ndots value used when resolving using search domains, the default value is |
|
|
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. |
|
|
Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed. |
|
|
Set the DNS queries Recursion Desired flag value. |
|
|
Set to |
|
|
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. |
|
|
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 |
AggregateOptions
Name |
Type |
Description |
|
Set the flag if writing to temporary files is enabled. |
|
|
Set the batch size for methods loading found data in batches. |
|
|
Set the time limit in milliseconds for processing operations on a cursor. |
AmqpClientOptions
Name |
Type |
Description |
|
||
|
Sets the container id. |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
Sets the host. |
|
|
||
|
||
Set the idle timeout unit. If not specified, default is seconds. |
||
|
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
||
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Sets the password. |
|
|
Sets the port. |
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Set the ALPN usage. |
|
|
Sets the username. |
|
|
AmqpReceiverOptions
Name |
Type |
Description |
|
Sets the auto-acknowledgement.
When enabled (default), the messages are automatically acknowledged. If set to |
|
|
Sets the list of desired capabilities A registry of commonly defined source capabilities and their meanings is maintained at AMQP Source Capabilities. |
|
|
Adds a desired capability. A registry of commonly defined source capabilities and their meanings is maintained at AMQP Source Capabilities. |
|
|
Sets the durability.
Passing |
|
|
Sets whether the link remote terminus to be used should indicate it is 'dynamic', requesting the peer names it with a dynamic address. The address provided by the peer can then be inspected using the link method on the link received once opened. |
|
|
- |
|
|
Sets the max buffered messages. This message can be used to configure the initial credit of a receiver. |
|
|
Sets the local QOS config. |
AmqpSenderOptions
Name |
Type |
Description |
|
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.
|
|
|
Sets whether the link remote terminus to be used should indicate it is 'dynamic', requesting the peer names it with a dynamic address. The address provided by the peer can then be inspected using the link method on the link received once opened. |
|
|
- |
ApolloWSOptions
Argument
Name |
Type |
Description |
|
Sets the argument name of this link. |
|
|
Sets the default value of this link. |
|
|
Sets the description of the link. |
|
|
|
Sets whether or not the current link is hidden. |
|
Sets the argument index. |
|
|
Sets whether or not the argument can receive several values. Only the last argument can receive several values. |
|
|
Sets whether or not the current link is required. |
AuthOptions
Name |
Type |
Description |
BlockingQueryOptions
Name |
Type |
Description |
|
Set index indicating that the client wishes to wait for any changes subsequent to that index. |
|
|
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
Name |
Type |
Description |
BulkOperation
Name |
Type |
Description |
|
Sets the document, used by insert, replace, and update operations |
|
|
Sets the filter document, used by replace, update, and delete operations |
|
|
Sets the multi flag, used by update and delete operations |
|
Sets the operation type |
||
|
Sets the upsert flag, used by update and replace operations |
BulkWriteOptions
Name |
Type |
Description |
|
Set the ordered option |
|
Set the write option |
CassandraClientOptions
Check
Name |
Type |
Description |
|
Set the ID of check |
|
|
Set the name of check |
|
|
Set the name of node |
|
|
Set the human-readable note of check |
|
|
Set the output of check |
|
|
Set the ID of service with which this check associated |
|
|
Set the name of service with which this check associated |
|
Set the status of check |
CheckList
CheckOptions
Name |
Type |
Description |
|
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. |
|
|
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 |
|
|
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 |
|
|
Set HTTP address to check. Also you should set checking interval |
|
|
Set check ID |
|
|
Set checking interval |
|
|
Set check name. This is mandatory field |
|
|
Set check notes |
|
|
Set scriptArgs. Also you should set checking interval |
|
|
Set the service ID to associate the registered check with an existing service provided by the agent. |
|
Set the check status to specify the initial state of the health check. |
||
|
Set TCP address to check. Also you should set checking interval |
|
|
Specifies if the certificate for an HTTPS check should not be verified. |
|
|
Set Time to Live of check. |
CheckQueryOptions
CircuitBreakerOptions
Name |
Type |
Description |
|
Sets the rolling window used for metrics. |
|
|
Sets whether or not the fallback is executed on failure, even when the circuit is closed. |
|
|
Sets the maximum number of failures before opening the circuit. |
|
|
Configures the number of times the circuit breaker tries to redo the operation before failing. |
|
|
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. |
|
|
Sets the rolling window used for metrics. |
|
|
Sets the event bus address on which the circuit breaker publish its state change. |
|
|
Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its current state. |
|
|
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. |
|
|
Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as a failure. |
ClientOptionsBase
Name |
Type |
Description |
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
ClusterDescription
Config
Name |
Type |
Description |
ConfigChange
ConfigEntry
Name |
Type |
Description |
|
Set whether the config value is the default or if it's been explicitly set |
|
|
Set the config name |
|
|
Set whether the config is read-only and cannot be updated |
|
|
Set whether the config value is sensitive. The value is always set to null by the broker if the config value is sensitive |
|
Set the source of this configuration entry |
||
|
Set the value or null. Null is returned if the config is unset or if isSensitive is true |
ConfigResource
Name |
Type |
Description |
|
Set if this is the default resource of a resource type. Resource name is empty for the default resource. |
|
|
Set the resource name |
|
Set the resource type |
ConfigRetrieverOptions
ConfigRetriever
.
Name |
Type |
Description |
|
Enables or disables the inclusion of the default stored in the configuration. |
|
|
Configures the scan period, in ms. This is the time amount between two checks of the configuration updates. |
ConfigStoreOptions
Name |
Type |
Description |
|
Sets the configuration of the store |
|
|
Sets the format of the configuration that is retrieved from the store. |
|
|
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). |
|
|
Sets the configuration type |
ConfigSynonym
Name |
Type |
Description |
|
Set the name of this configuration |
|
Set the source of this configuration |
||
|
Set the value of this configuration, which may be null if the configuration is sensitive |
ConsulClientOptions
Name |
Type |
Description |
|
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. |
|
|
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:
|
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
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. |
|
|
set to |
|
|
Set the default host name to be used by this client in requests if none is provided when making the request. |
|
|
Set the default port to be used by this client in requests if none is provided when making the request. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Configure the default behavior of the client to follow HTTP |
|
|
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to |
|
|
Set to |
|
|
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.
|
|
|
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 of0 means there is no timeout.
|
|
|
Set the maximum pool size for HTTP/2 connections |
|
|
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.
|
|
|
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. |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set whether keep alive is enabled on the client |
|
|
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 of0 means there is no timeout.
|
|
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the maximum HTTP chunk size |
|
|
Set the maximum length of all headers for HTTP/1.x . |
|
|
Set the maximum length of the initial line for HTTP/1.x (e.g. |
|
|
Set the maximum pool size for connections |
|
|
Set to |
|
|
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. |
|
|
Set the max websocket frame size |
|
|
Set the max websocket message size |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set whether pipe-lining is enabled on the client |
|
|
Set the limit of pending requests a pipe-lined HTTP/1 connection can send. |
|
|
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. |
|
Set the protocol version. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
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. |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
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. |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set whether compression is enabled |
|
|
Set whether the client will offer the WebSocket per-frame deflate compression extension. |
|
|
Set whether the client will offer the WebSocket per-message deflate compression extension. |
|
|
||
|
Set the ALPN usage. |
|
|
Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>. |
|
|
Sets whether the Web Client should send a user agent header. Defaults to true. |
|
|
Set whether hostname verification is enabled |
|
|
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 |
|
|
Set whether the |
|
|
Set the WebSocket deflate compression level. |
|
|
Set whether the |
ConsumerGroupDescription
Name |
Type |
Description |
|
Set the id of the consumer group |
|
|
Set the consumer group partition assignor |
|
|
Set if consumer group is simple or not |
|
Set the consumer group state, or UNKNOWN if the state is too new for us to parse |
ConsumerGroupListing
Coordinate
CoordinateList
CopyOptions
Name |
Type |
Description |
|
Whether move should be performed as an atomic filesystem operation. Defaults to |
|
|
Whether the file attributes should be copied. Defaults to |
|
|
Whether symbolic links should not be followed during copy or move operations. Defaults to |
|
|
Whether an existing file, empty directory, or link should be replaced. Defaults to |
DB2ConnectOptions
Name |
Type |
Description |
|
Set whether prepared statements cache should be enabled. |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Specify the default database for the connection. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Specify the host for connecting to the server. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Specify the user password to be used for the authentication. |
|
|
- |
|
|
Specify the port for connecting to the server. |
|
|
Set the maximum number of prepared statements that the connection will cache. |
|
|
Set the maximum length of prepared statement SQL string that the connection will cache. This is an helper setting the link. |
|
|
Set properties for this client, which will be sent to server at the connection start. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Specify the user account to be used for the authentication. |
DKIMSignOptions
Name |
Type |
Description |
|
Sets the Agent or User Identifier(AUID) |
|
Sets the canonicalization algorithm for mail body. |
||
|
Sets the body limit to sign. |
|
|
Sets the copied headers used in DKIM. |
|
|
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. |
|
Sets the canonicalization algorithm for signed headers. |
||
|
Sets the PKCS#8 format private key used to sign the email. |
|
|
Sets the PKCS#8 format private key file path. |
|
|
Sets the Singing Domain Identifier(SDID). |
|
|
Sets the selector used to query the public key. |
|
Sets the signing algorithm. |
||
|
Sets to enable or disable signature sign timestmap. Default is disabled. |
|
|
Sets the email signedHeaders used to sign. |
DatagramSocketOptions
Name |
Type |
Description |
|
Set if the socket can send or receive broadcast packets |
|
|
Set if IP v6 should be used |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set if loopback mode is disabled |
|
|
Set the multicast network interface address |
|
|
Set the multicast ttl value |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set the value of traffic class |
DcCoordinates
DeliveryOptions
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 |
|
Set the codec name. |
|
|
Add a message header. Message headers can be sent with any message and will be accessible with link at the recipient. |
|
|
Whether a message should be delivered to local consumers only. Defaults to This option is effective in clustered mode only and does not apply to reply messages. |
|
|
Set the send timeout. |
DeploymentOptions
Name |
Type |
Description |
|
Set the JSON configuration that will be passed to the verticle(s) when it's deployed |
|
|
Set whether the verticle(s) will be deployed as HA. |
|
|
Set the number of instances that should be deployed. |
|
|
Sets the value of max worker execute time, in link. The default value of link is |
|
Set the time unit of |
||
|
Set whether the verticle(s) should be deployed as a worker verticle |
|
|
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. |
|
|
Set the maximum number of worker threads to be used by the Vert.x instance. |
DnsClientOptions
Name |
Type |
Description |
|
Set the host name to be used by this client in requests. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the port to be used by this client in requests. |
|
|
Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed. |
|
|
Set whether or not recursion is desired |
DropwizardMetricsOptions
Name |
Type |
Description |
|
Set a custom baseName for metrics. |
|
|
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. |
|
|
Set whether metrics will be enabled on the Vert.x instance. |
|
|
Set the JMX domain to use when JMX metrics are enabled. |
|
|
Set whether JMX will be enabled on the Vert.x instance. |
|
|
Set the name used for registering the metrics in the Dropwizard shared registry. |
Event
Name |
Type |
Description |
|
Set ID of event |
|
|
Set the Lamport clock time |
|
|
Set name of event |
|
|
Set regular expression to filter by node name |
|
|
Set payload of event |
|
|
Set regular expression to filter by service |
|
|
Set regular expression to filter by tag |
|
|
Set version |
EventBusOptions
Name |
Type |
Description |
|
Set the accept back log. |
|
Set whether client auth is required |
||
|
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. |
|
|
Set the value of cluster ping interval, in ms. |
|
|
Set the value of cluster ping reply interval, in ms. |
|
|
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. |
|
|
See link for an explanation. |
|
|
Sets the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Sets the host. Defaults to
When the clustered eventbus starts, it tries to bind to the provided |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Sets the port. |
|
|
Set the TCP receive buffer size |
|
|
Sets the value of reconnect attempts. |
|
|
Set the reconnect interval. |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted. |
|
|
Set the ALPN usage. |
EventList
EventListOptions
EventOptions
FileSystemOptions
Name |
Type |
Description |
|
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 |
|
|
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. |
|
|
Set to |
FindOptions
Frame
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 |
|
Gets the value of the |
|
|
Sets the body of the frame. |
|
|
Gets the body of the frames as a String encoded in the frame encoding. |
|
Sets the frame command. |
||
|
- |
|
|
Sets the headers of the frames. |
|
|
- |
|
|
- |
|
|
- |
GoAway
GraphQLHandlerOptions
GraphiQLHandlerOptions
Name |
Type |
Description |
|
Whether the GraphiQL development tool should be enabled. Defaults to |
|
|
Set the GraphQL endpoint URI. Defaults to the path used to get the GraphiQL user interface. |
|
|
A fixed set of HTTP headers to add to GraphiQL requests. Defaults to |
|
|
Initial value of the query area in the GraphiQL user interface. Defaults to |
|
|
Initial value of the variables area in the GraphiQL user interface. Defaults to |
GridFsDownloadOptions
GridFsUploadOptions
HtdigestCredentials
HtpasswdAuthOptions
Http2PushMapping
Http2Settings
The settings expose the parameters defined by the HTTP/2 specification, as well as extra settings for protocol extensions.
Name |
Type |
Description |
|
Set HTTP/2 setting. |
|
|
Set the HTTP/2 setting |
|
|
Set the HTTP/2 setting |
|
|
Set the HTTP/2 setting |
|
|
Set the HTTP/2 setting |
|
|
Set the HTTP/2 setting |
HttpClientOptions
Name |
Type |
Description |
|
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:
|
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
set to |
|
|
Set the default host name to be used by this client in requests if none is provided when making the request. |
|
|
Set the default port to be used by this client in requests if none is provided when making the request. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to |
|
|
Set to |
|
|
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.
|
|
|
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 of0 means there is no timeout.
|
|
|
Set the maximum pool size for HTTP/2 connections |
|
|
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.
|
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set whether keep alive is enabled on the client |
|
|
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 of0 means there is no timeout.
|
|
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the maximum HTTP chunk size |
|
|
Set the maximum length of all headers for HTTP/1.x . |
|
|
Set the maximum length of the initial line for HTTP/1.x (e.g. |
|
|
Set the maximum pool size for connections |
|
|
Set to |
|
|
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. |
|
|
Set the max WebSocket frame size |
|
|
Set the max WebSocket message size |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set whether pipe-lining is enabled on the client |
|
|
Set the limit of pending requests a pipe-lined HTTP/1 connection can send. |
|
|
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. |
|
Set the protocol version. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set
You may want to set it
It's |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set whether compression is enabled |
|
|
Set whether the client will offer the WebSocket per-frame deflate compression extension. |
|
|
Set whether the client will offer the WebSocket per-message deflate compression extension. |
|
|
||
|
Set the ALPN usage. |
|
|
Set whether hostname verification is enabled |
|
|
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 |
|
|
Set whether the |
|
|
Set the WebSocket deflate compression level. |
|
|
Set whether the |
HttpLocation
Name |
Type |
Description |
|
Sets the endpoint, which is the URL of the service. The endpoint is automatically computed when you use the other `setX` method. |
|
|
Sets the host. |
|
|
Sets the port |
|
|
Sets the path of the service (root) |
|
|
Sets whether or not the HTTP service is using |
HttpMethod
Name |
Type |
Description |
HttpServerOptions
Name |
Type |
Description |
|
Set the accept back log |
|
|
Set |
|
|
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. |
|
Set whether client auth is required |
||
|
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 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 |
|
|
Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Set the initial buffer size for the HTTP decoder |
|
|
Set whether the server supports decompression |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set whether 100 Continue should be handled automatically |
|
|
Set the host |
|
|
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.
|
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the maximum HTTP chunk size that link will receive |
|
|
Set the maximum length of all headers for HTTP/1.x . |
|
|
Set the maximum length of the initial line for HTTP/1.x (e.g. |
|
|
Set the maximum WebSocket frames size |
|
|
Set the maximum WebSocket message size |
|
|
Enable or disable support for the WebSocket per-frame deflate compression extension. |
|
|
Enable or disable support for WebSocket per-message deflate compression extension. |
|
|
Set the port |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
|
|
Set whether the WebSocket server will accept the |
|
|
Set the WebSocket compression level. |
|
|
Set whether the WebSocket server will accept the |
|
|
Set the WebSocket list of sub-protocol supported by the server. |
HttpTermOptions
Name |
Type |
Description |
|
Set the accept back log |
|
|
Set |
|
|
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. |
|
|
Set the auth options. |
|
|
Set the charset used for encoding / decoding text data from/to SockJS |
|
Set whether client auth is required |
||
|
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 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 |
|
|
Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Set the initial buffer size for the HTTP decoder |
|
|
Set whether the server supports decompression |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set whether 100 Continue should be handled automatically |
|
|
Set the host |
|
|
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.
|
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
The path of the inputrc config. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the maximum HTTP chunk size that will receive |
|
|
Set the maximum length of all headers for HTTP/1.x . |
|
|
Set the maximum length of the initial line for HTTP/1.x (e.g. |
|
|
Set the maximum WebSocket frames size |
|
|
Set the maximum WebSocket message size |
|
|
Enable or disable support for the WebSocket per-frame deflate compression extension. |
|
|
Enable or disable support for WebSocket per-message deflate compression extension. |
|
|
Set the port |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Configure the SockJS path, the default value is |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
|
|
Set |
|
|
Set whether the WebSocket server will accept the |
|
|
Set the WebSocket compression level. |
|
|
Set whether the WebSocket server will accept the |
|
|
Set the WebSocket list of sub-protocol supported by the server. |
IndexOptions
Name |
Type |
Description |
|
Create the index in the background |
|
|
Gets the number of precision of the stored geohash value of the location data in 2d indexes. |
|
|
Gets the specified the number of units within which to group the location values for geoHaystack Indexes |
|
|
Gets the language for a text index. The language that determines the list of stop words and the rules for the stemmer and tokenizer. |
|
|
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. |
|
|
Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes.. |
|
|
Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes.. |
|
|
Gets the name of the index. |
|
|
Get the filter expression for the documents to be included in the index or null if not set |
|
|
If true, the index only references documents with the specified field |
|
|
Gets the 2dsphere index version number. |
|
|
Gets the storage engine options document for this index. |
|
|
The text index version number. |
|
|
Gets if the index should be unique. |
|
|
Gets the index version number. |
|
|
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
Name |
Type |
Description |
|
Set the authentication query to use. Use this if you want to override the default authentication query. |
|
|
The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration. |
|
|
Set the data source name to use, only use in shared mode. |
|
|
Set the permissions query to use. Use this if you want to override the default permissions query. |
|
|
Set the role prefix to distinguish from permissions when checking for isPermitted requests. |
|
|
Set the roles query to use. Use this if you want to override the default roles query. |
|
|
Set whether the JDBC client is shared or non shared. |
JDBCAuthenticationOptions
JDBCAuthorizationOptions
JDBCConnectOptions
JWTAuthOptions
JWTOptions
Name |
Type |
Description |
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
The permissions of this token. |
|
|
||
|
||
|
- |
JdkSSLEngineOptions
Name |
Type |
Description |
JksOptions
When used as a key store, it should point to a store containing a private key and its certificate. When used as a trust store, it should point to a store containing a list of trusted certificates.
The store can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = HttpServerOptions.httpServerOptions(); options.setKeyStore(new JKSOptions().setPath("/mykeystore.jks").setPassword("foo"));Or directly provided as a buffer:
Buffer store = vertx.fileSystem().readFileBlocking("/mykeystore.jks"); options.setKeyStore(new JKSOptions().setValue(store).setPassword("foo"));
Name |
Type |
Description |
|
Set the password for the key store |
|
|
Set the path to the key store |
|
|
Set the key store as a buffer |
KeyStoreOptions
KeyValue
Name |
Type |
Description |
|
Set the internal index value that represents when the entry was created. |
|
|
Set the flags attached to this entry. Clients can choose to use this however makes sense for their application. |
|
|
Set the key |
|
|
Set the number of times this key has successfully been acquired in a lock. |
|
|
Set the last index that modified this key. |
|
|
Set the session that owns the lock |
|
|
Set the value |
KeyValueList
KeyValueOptions
Name |
Type |
Description |
|
Set session ID for lock acquisition operation. |
|
|
Set the Check-And-Set index. If the index is |
|
|
Set the flags. Flags is an value between |
|
|
Set session ID for lock release operation. |
ListConsumerGroupOffsetsOptions
Name |
Type |
Description |
MailConfig
Name |
Type |
Description |
|
set if sending allows rcpt errors if true, the mail will be sent to the recipients that the server accepted, if any
|
|
|
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 |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
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.
|
|
|
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. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the hostname of the smtp server. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
set if connection pool is enabled default is true if the connection pooling is disabled, the max number of sockets is enforced nevertheless
|
|
|
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) |
|
|
get the key store password to be used when opening SMTP connections |
|
|
Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
Set the login mode for the connection. Either DISABLED, OPTIONAL or REQUIRED |
||
|
set the max allowed number of open connections to the mail server if not set the default is 10 |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
set the hostname to be used for HELO/EHLO and the Message-ID |
|
|
Set the password for the login. |
|
|
Sets to enable/disable the pipelining capability if SMTP server supports it. |
|
|
Set the port of the smtp server. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
Set the tls security mode for the connection. Either NONE, OPTIONAL or REQUIRED |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Sets the Mail User Agent(MUA) name. It is used to generate the boundary in case of MultiPart email and the Message-ID. If |
|
|
Set the username for the login. |
MailMessage
Name |
Type |
Description |
|
set list of bcc addresses |
|
|
set bounce address of this mail |
|
|
set list of cc addresses |
|
|
set whether our own headers should be the only headers added to the message |
|
|
set from address of this mail |
|
|
Add a message header. |
|
|
set the html text of this mail |
|
|
set the subject of this mail |
|
|
set the plain text of this mail |
|
|
set list of to addresses |
MailResult
MaintenanceOptions
Name |
Type |
Description |
|
Set maintenance mode to enabled: |
|
|
Set the ID of service. This field is required. |
|
|
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
Name |
Type |
Description |
|
Set an alias that would replace the label value when it matches. |
|
Set the label domain, restricting this rule to a single domain. |
||
|
Set the label name. The match will apply to the values related to this key. |
|
Set the type of matching to apply. |
||
|
Set the matched value. |
Match
Name |
Type |
Description |
|
Set the alias the human readable name that will be used as a part of registry entry name when the value matches. |
|
Set the type of matching to apply. |
||
|
Set the matched value. |
MemberAssignment
Name |
Type |
Description |
MemberDescription
MetricsOptions
MicrometerMetricsOptions
It is required to set either influxDbOptions
, prometheusOptions
or jmxMetricsOptions
(or, programmatically, micrometerRegistry
) in order to actually report metrics.
Name |
Type |
Description |
|
Sets metrics types that are disabled. |
|
|
Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default. |
|
|
Whether JVM metrics should be collected. Defaults to |
|
|
Sets enabled labels. These labels can be fine-tuned later on using Micrometer's Meter filters (see http://micrometer.io/docs/concepts#_meter_filters) |
|
|
Set a name for the metrics registry, so that a new registry will be created and associated with this name.
If |
MongoAuthOptions
Name |
Type |
Description |
|
The property name to be used to set the name of the collection inside the config. |
|
|
The mongo client configuration: see Mongo Client documentation. |
|
|
The mongo data source name: see Mongo Client documentation. |
|
|
The property name to be used to set the name of the field, where the password is stored inside |
|
|
The property name to be used to set the name of the field, where the permissions are stored inside. |
|
|
The property name to be used to set the name of the field, where the roles are stored inside. |
|
|
The property name to be used to set the name of the field, where the SALT is stored inside. |
|
The property name to be used to set the name of the field, where the salt style is stored inside |
||
|
Use a shared Mongo client or not. |
|
|
The property name to be used to set the name of the field, where the username for the credentials is stored inside. |
|
|
The property name to be used to set the name of the field, where the username is stored inside. |
MongoAuthenticationOptions
Name |
Type |
Description |
|
The property name to be used to set the name of the collection inside the config. |
|
|
- |
|
|
The property name to be used to set the name of the field, where the password is stored inside |
|
|
The property name to be used to set the name of the field, where the username for the credentials is stored inside. |
|
|
The property name to be used to set the name of the field, where the username is stored inside. |
MongoAuthorizationOptions
Name |
Type |
Description |
|
The property name to be used to set the name of the collection inside the config. |
|
|
The property name to be used to set the name of the field, where the permissions are stored inside. |
|
|
The property name to be used to set the name of the field, where the roles are stored inside. |
|
|
The property name to be used to set the name of the field, where the username is stored inside. |
MongoClientBulkWriteResult
Name |
Type |
Description |
|
Returns the number of deleted documents |
|
|
Returns the number of inserted documents |
|
|
Returns the number of matched documents |
|
|
Returns the number of modified documents |
|
|
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
MongoClientUpdateResult
MqttClientOptions
Name |
Type |
Description |
|
Set if the MQTT client must generate clientId automatically (default is true) |
|
|
Set if the MQTT client must handle PINGREQ automatically (default is true) |
|
|
Set to start with a clean session (or not) |
|
|
Set the client identifier |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
Do the same thing as link. Use it instead. |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set the keep alive timeout in seconds |
|
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set max count of unacknowledged messages |
|
|
Set max MQTT message size |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set the password |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Set the username |
|
|
Set if will information are provided on connection |
|
|
Set the content of the will message |
|
|
Set the QoS level for the will message |
|
|
Set if the will message must be retained |
|
|
Set the topic on which the will message will be published |
MqttServerOptions
Name |
Type |
Description |
|
Set the accept back log |
|
|
Set if clientid should be auto-generated when it's "zero-bytes" |
|
Set whether client auth is required |
||
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the host |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set max MQTT message size |
|
|
Set the port |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the timeout on CONNECT packet |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
MqttWill
MySQLAuthOptions
Name |
Type |
Description |
|
Set the charset for the connection. |
|
|
Set the collation for the connection. |
|
|
Specify the default database for the re-authentication. |
|
|
Specify the user password to be used for the authentication. |
|
|
Set connection attributes which will be sent to server at the re-authentication. |
|
|
Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. |
|
|
Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. |
|
|
Specify the user account to be used for the authentication. |
MySQLConnectOptions
Name |
Type |
Description |
|
Set whether prepared statements cache should be enabled. |
|
|
Set the Java charset for encoding string values, this value is UTF-8 by default. |
|
|
Set the charset for the connection. |
|
|
Set the collation for the connection. |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Specify the default database for the connection. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Specify the host for connecting to the server. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Specify the user password to be used for the authentication. |
|
|
Specify the port for connecting to the server. |
|
|
Set the maximum number of prepared statements that the connection will cache. |
|
|
Set the maximum length of prepared statement SQL string that the connection will cache. This is an helper setting the link. |
|
|
Set properties for this client, which will be sent to server at the connection start. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. |
|
|
Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication. |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
Set the link for the client, this option can be used to specify the desired security state of the connection to the server. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Sets how affected rows are calculated on update/delete/insert, if set to See mysql-affected-rows for details. |
|
|
Set the ALPN usage. |
|
|
Specify the user account to be used for the authentication. |
NetClientOptions
Name |
Type |
Description |
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
NetServerOptions
Name |
Type |
Description |
|
Set the accept back log |
|
Set whether client auth is required |
||
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the host |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the port |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
NetworkOptions
Name |
Type |
Description |
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set the value of traffic class |
NewTopic
Name |
Type |
Description |
|
Set the configuration for the new topic or null if no configs ever specified |
|
|
Set the name of the topic to be created |
|
|
Set the number of partitions for the new topic or -1 if a replica assignment has been specified |
|
|
Set the replication factor for the new topic or -1 if a replica assignment has been specified |
Node
Node
Name |
Type |
Description |
|
||
|
Set if this node has a defined rack |
|
|
Set the host name for this node |
|
|
Set the node id of this node |
|
|
Set the string representation of the node id |
|
|
Set if this node is empty |
|
|
Set the port for this node |
|
|
Set the rack for this node |
NodeList
NodeQueryOptions
OAuth2Options
Name |
Type |
Description |
|
Get the Oauth2 authorization resource path. e.g.: /oauth/authorize |
|
|
Set the provider client id |
|
|
Set the provider client secret |
|
|
Override the HTTP form field name for client secret |
|
|
Set extra parameters to be sent to the provider on each request |
|
- |
||
|
Set custom headers to be sent with every request to the provider |
|
|
Set the provider token introspection resource path |
|
|
- |
|
|
Set the provider logout path |
|
|
Set the Oauth2 revocation resource path. e.g.: /oauth/revoke |
|
|
Set the provider scope separator |
|
|
Root URL for the provider without trailing slashes |
|
|
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`. |
|
|
Get the Oauth2 token resource path. e.g.: /oauth/token |
|
|
Flag to use HTTP basic auth header with client id, client secret. |
|
|
Set a custom user agent to use when communicating to a provider |
|
|
Set custom parameters to be sent during the userInfo resource request |
|
|
Set the provider userInfo resource path |
|
|
- |
Oauth2Credentials
OffsetAndMetadata
OffsetAndTimestamp
OpenOptions
Name |
Type |
Description |
|
Whether the file should be opened in append mode. Defaults to |
|
|
Set whether the file should be created if it does not already exist. |
|
|
Set whether the file should be created and fail if it does exist already. |
|
|
Set whether the file should be deleted when it's closed, or the JVM is shutdown. |
|
|
Set whether every write to the file's content ill be written synchronously to the underlying hardware. |
|
|
Set the permissions string |
|
|
Set whether the file is to be opened for reading |
|
|
Set whether a hint should be provided that the file to created is sparse |
|
|
Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware. |
|
|
Set whether the file should be truncated to zero length on opening if it exists and is opened for write |
|
|
Set whether the file is to be opened for writing |
OpenSSLEngineOptions
OperationRequest
OperationResponse
Option
Name |
Type |
Description |
|
Sets te arg name for this option. |
|
|
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. |
|
|
Sets the default value of this option |
|
|
Sets te description of this option. |
|
|
Configures the current link to be a flag. It will be evaluated to |
|
|
Sets whether or not this option is a "help" option |
|
|
|
Sets whether or not this option should be hidden |
|
Sets the long name of this option. |
|
|
Sets whether or not this option can receive several values. |
|
|
||
|
Sets whether or not this option is mandatory. |
|
|
Sets the short name of this option. |
|
|
Sets whether or not this option can receive a value. |
PartitionInfo
PemKeyCertOptions
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 |
|
Set the path of the first certificate, replacing the previous certificates paths |
|
|
Set all the paths to the certificates files |
|
|
Set the first certificate as a buffer, replacing the previous certificates buffers |
|
|
Set all the certificates as a list of buffer |
|
|
Set the path of the first key file, replacing the keys paths |
|
|
Set all the paths to the keys files |
|
|
Set the first key a a buffer, replacing the previous keys buffers |
|
|
Set all the keys as a list of buffer |
PemTrustOptions
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 |
|
Add a certificate path |
|
|
Add a certificate value |
PermittedOptions
Name |
Type |
Description |
|
The exact address the message is being sent to. If you want to allow messages based on an exact address you use this field. |
|
|
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. |
|
|
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. |
|
|
Declare a specific authority that user must have in order to allow messages |
PfxOptions
When used as a key store, it should point to a store containing a private key and its certificate. When used as a trust store, it should point to a store containing a list of accepted certificates.
The store can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = new HttpServerOptions(); options.setPfxKeyCertOptions(new PfxOptions().setPath("/mykeystore.p12").setPassword("foo"));Or directly provided as a buffer:
Buffer store = vertx.fileSystem().readFileBlocking("/mykeystore.p12"); options.setPfxKeyCertOptions(new PfxOptions().setValue(store).setPassword("foo"));
Name |
Type |
Description |
|
Set the password |
|
|
Set the path |
|
|
Set the store as a buffer |
PgConnectOptions
Name |
Type |
Description |
|
Set whether prepared statements cache should be enabled. |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Specify the default database for the connection. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Specify the host for connecting to the server. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Specify the user password to be used for the authentication. |
|
|
- |
|
|
Specify the port for connecting to the server. |
|
|
Set the maximum number of prepared statements that the connection will cache. |
|
|
Set the maximum length of prepared statement SQL string that the connection will cache. This is an helper setting the link. |
|
|
Set properties for this client, which will be sent to server at the connection start. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
Set link for the client, this option can be used to provide different levels of secure protection. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Specify the user account to be used for the authentication. |
|
|
- |
PgNotification
PoolOptions
Name |
Type |
Description |
|
Set the maximum pool size |
|
|
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
Name |
Type |
Description |
|
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. |
|
|
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. |
|
|
Set ID of the query, always generated by Consul |
|
|
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. |
|
|
Set an optional friendly name that can be used to execute a query instead of using its ID |
|
|
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. |
|
|
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. |
|
|
Set the name of the service to query |
|
|
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. |
|
|
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 `!`). |
|
|
Set regular expression which is used to extract fields from the entire name, once this template is selected. |
|
|
The template type, which must be |
|
|
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
Name |
Type |
Description |
|
Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling. |
|
|
Set node name for sorting the list in ascending order based on the estimated round trip time from that node.
Passing |
PreparedQueryExecuteResponse
Name |
Type |
Description |
|
Set the datacenter that ultimately provided the list of nodes |
|
|
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. |
|
|
Set the number of remote datacenters that were queried while executing the query. |
|
|
Set the service name that the query was selecting. This is useful for context in case an empty list of nodes is returned. |
ProxyOptions
Name |
Type |
Description |
|
Set proxy host. |
|
|
Set proxy password. |
|
|
Set proxy port. |
|
Set proxy type. ProxyType can be HTTP, SOCKS4 and SOCKS5 |
||
|
Set proxy username. |
PubSecKeyOptions
Record
Name |
Type |
Description |
|
Sets the json object describing the location of the service. By convention, this json object should contain the link entry. |
|
|
Gets the metadata attached to the record. |
|
|
Sets the name of the service. It can reflect the service name of the name of the provider. |
|
|
Sets the registration id. This method is called when the service is published. |
|
Sets the status of the service. When published, the status is set to. When withdrawn, the status is set to . |
||
|
Sets the type of service. |
RecordMetadata
Name |
Type |
Description |
|
Set the checksum (CRC32) of the record. |
|
|
Set the offset of the record in the topic/partition. |
|
|
Set the partition the record was sent to |
|
|
Set the timestamp of the record in the topic/partition |
|
|
Set the topic the record was appended to |
RedisOptions
Name |
Type |
Description |
|
Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings. |
|
|
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. |
|
|
Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings. |
|
|
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. |
|
|
Set the master name (only considered in HA mode). |
|
|
Tune how much nested arrays are allowed on a redis response. This affects the parser performance. |
|
|
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) |
|
|
Tune the maximum waiting requests for a connection from the pool. |
|
|
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. |
|
|
Set the default password for cluster/sentinel connections. |
|
|
Tune how often in milliseconds should the connection pool cleaner execute. |
|
|
Tune when a connection should be recycled in milliseconds. |
|
Set the role name (only considered in HA mode). |
||
Set the desired client type to be created. |
||
Set whether or not to use slave nodes (only considered in Cluster mode). |
ReportOptions
ReportingOptions
- the
reporters
is an array of reporter configurations
Name |
Type |
Description |
RequestOptions
Name |
Type |
Description |
|
Parse an absolute URI to use, this will update the |
|
|
Set whether to follow HTTP redirect |
|
|
Add a request header. |
|
|
Set the host name to be used by the client request. |
|
|
Set the port to be used by the client request. |
|
|
Set whether SSL/TLS is enabled. |
|
|
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. |
|
|
Set the request relative URI. |
ResultSet
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 |
|
Get the column names |
|
|
Return the number of columns in the result set |
|
|
Return the number of rows in the result set |
|
|
Get the registered outputs |
|
|
Get the results |
|
|
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 tablethe column names are not required to be: aand band could be in fact Aand B. For cases when there is the need for case insentivitity you should see link |
RouterFactoryOptions
Name |
Type |
Description |
|
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 |
|
|
If true, when required, the factory will mount a link |
|
|
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. |
|
|
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. |
|
|
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
Name |
Type |
Description |
|
- |
|
|
- |
|
|
- |
|
- |
||
|
- |
|
|
- |
|
|
- |
|
- |
||
- |
||
|
- |
|
- |
SSHTermOptions
Name |
Type |
Description |
|
Set the auth options. |
|
|
Set the default charset to use when the client does not specifies one. |
|
|
Set the host |
|
|
The path of the inputrc config. |
|
|
Set the port |
SchemaRouterOptions
Service
Name |
Type |
Description |
|
Set service address |
|
|
Set ID of service |
|
|
Specifies arbitrary KV metadata linked to the service instance. |
|
|
Set service name |
|
|
Set node name |
|
|
Set node address |
|
|
Set service port |
|
|
Set list of service tags |
ServiceDiscoveryOptions
Name |
Type |
Description |
|
Sets the event bus address on which the service arrivals, departures and modifications are announced. This address must be consistent in the whole application. |
|
|
Sets whether or not the registration of importers declared as SPI is enabled. |
|
|
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. |
|
|
Sets the service discovery name used in the service usage events. If not set, the node id is used. |
|
|
Sets the usage address: the event bus address on which are sent the service usage events (bind / release). |
ServiceEntry
Name |
Type |
Description |
ServiceEntryList
ServiceList
ServiceOptions
Name |
Type |
Description |
|
Set service address |
|
|
Set the ID of session |
|
|
Specifies arbitrary KV metadata linked to the service instance. |
|
|
Set service name |
|
|
Set service port |
|
|
Set list of tags associated with service |
ServiceQueryOptions
Session
Name |
Type |
Description |
|
Set the list of associated health checks |
|
|
Set the create index of session |
|
|
Set the ID of node |
|
|
Set Consul index |
|
|
Set the Lock delay of session |
|
|
Set the ID of node |
SessionList
SessionOptions
Name |
Type |
Description |
Set the behavior when a session is invalidated. The release behavior is the default if none is specified. |
||
|
Set a list of associated health checks. It is highly recommended that, if you override this list, you include the default "serfHealth" |
|
|
Set the lock-delay period. |
|
|
Set the human-readable name for the Session |
|
|
Set the node to which the session will be assigned |
|
|
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 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
Name |
Type |
Description |
|
Set the repear interval, i.e the period at which session eviction is performed. |
|
|
Set the session timeout. |
|
|
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell. |
ShellServiceOptions
Name |
Type |
Description |
|
Set the repear interval, i.e the period at which session eviction is performed. |
|
|
Set the session timeout. |
|
|
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell. |
ShiroAuthOptions
Name |
Type |
Description |
|
Set the Shiro auth config. |
|
Set the Shiro auth options type. |
SockJSBridgeOptions
SockJSHandlerOptions
SqlConnectOptions
Name |
Type |
Description |
|
Set whether prepared statements cache should be enabled. |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Specify the default database for the connection. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Specify the host for connecting to the server. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Specify the user password to be used for the authentication. |
|
|
Specify the port for connecting to the server. |
|
|
Set the maximum number of prepared statements that the connection will cache. |
|
|
Set the maximum length of prepared statement SQL string that the connection will cache. This is an helper setting the link. |
|
|
Set properties for this client, which will be sent to server at the connection start. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Specify the user account to be used for the authentication. |
Status
Name |
Type |
Description |
|
Sets the metadata. |
|
|
Sets whether or not the current status is positive (UP) or negative (DOWN). |
|
|
Sets whether or not the procedure attached to this status has failed (timeout, error...). |
StompClientOptions
Name |
Type |
Description |
|
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: |
|
|
Sets whether or not the automatic computation of the |
|
|
Sets whether or not the |
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Sets the heartbeat configuration. |
|
|
Sets the STOMP server host. |
|
|
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Sets the login to use if the STOMP server is secured. |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Sets the passcode to use if the STOMP server is secured. |
|
|
Sets the STOMP server port. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reconnect attempts |
|
|
Set the reconnect interval |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
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. |
|
|
Set whether all server certificates should be trusted |
|
|
Set the ALPN usage. |
|
|
Sets whether or not the connection is made using the |
|
|
Sets the virtual host that will be used as "host" header value in the `CONNECT` frame. |
StompServerOptions
Name |
Type |
Description |
|
Set the accept back log |
|
Set whether client auth is required |
||
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Sets the heartbeat configuration. |
|
|
Set the host |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Sets the max body length accepted by the server. 10 Mb by default. |
|
|
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 |
|
|
Sets the max header length. |
|
|
Sets the maximum number of headers. 1000 by default. |
|
|
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. |
|
|
Sets the port on which the server is going to listen for TCP connection. |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Enables or disables the server security feature. It requires an link handler. |
|
|
Set the TCP send buffer size |
|
|
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). |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order. |
|
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Sets the time factor. |
|
|
Set the value of traffic class |
|
|
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. |
|
|
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. |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
|
|
Enables or disables the web socket bridge. |
|
|
Sets the websocket path. Only frames received on this path would be considered as STOMP frame. |
StreamPriority
TCPSSLOptions
Name |
Type |
Description |
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
TelnetTermOptions
Name |
Type |
Description |
|
Set the accept back log |
|
|
Set the charset to use when binary mode is active, see link and link. |
|
Set whether client auth is required |
||
|
Add a CRL path |
|
|
Add a CRL value |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Set the host |
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
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. |
|
|
The path of the inputrc config. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
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. |
|
|
Set the port |
|
|
Set the Proxy protocol timeout, default time unit is seconds. |
|
Set the Proxy protocol timeout unit. If not specified, default is seconds. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set whether the server supports Server Name Indiciation |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set the ALPN usage. |
|
|
Set whether the server uses the HA Proxy protocol |
TestOptions
- the
timeout
in milliseconds, the default value is 2 minutes - the
useEventLoop
configures the event loop usage
true
always runs with an event loopfalse
never runs with an event loopnull
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 |
|
Set the test timeout. |
|
|
Configure the execution to use an event loop when there is no one existing. |
TokenCredentials
TopicDescription
TopicPartition
TopicPartitionInfo
TracingOptions
Name |
Type |
Description |
TxnError
TxnKVOperation
Name |
Type |
Description |
|
Set the flags attached to this entry. Clients can choose to use this however makes sense for their application. |
|
|
Set the index used for locking, unlocking, and check-and-set operations. |
|
|
Set the key |
|
|
Set the session used for locking, unlocking, and check-and-set operations. |
|
Set the type of operation to perform |
||
|
Set the value |
TxnRequest
TxnResponse
UpdateOptions
Name |
Type |
Description |
|
Set the arrayFilters option |
|
|
Set whether multi is enabled |
|
|
Set whether new document property is enabled. Valid only on findOneAnd* methods. |
|
|
Set whether upsert is enabled |
|
Set the write option |
UpdateResult
UsernamePasswordCredentials
VertxInfluxDbOptions
Name |
Type |
Description |
|
Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. Default is 10000. |
|
|
Activate or deactivate GZIP compression. It is activated by default. |
|
|
Connection timeout for InfluxDB server connections, in seconds. Default is 1 second. |
|
|
Database name used to store metrics. Default is "default". |
|
|
Set true to enable InfluxDB reporting |
|
|
Number of threads to use by the push scheduler. Default is 2. |
|
|
Password used for authenticated connections |
|
|
Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds. |
|
|
InfluxDB retention policy |
|
|
Push interval steps, in seconds. Default is 10 seconds. |
|
|
URI of the InfluxDB server. Example: http://influx:8086. |
|
|
Username used for authenticated connections |
VertxJmxMetricsOptions
VertxOptions
Name |
Type |
Description |
|
Sets the value of blocked thread check period, in link. The default value of link is |
|
Set the time unit of |
||
|
Set the number of event loop threads to be used by the Vert.x instance. |
|
|
Set whether HA will be enabled on the Vert.x instance. |
|
|
Set the HA group to be used when HA is enabled. |
|
|
Set the value of internal blocking pool size |
|
|
Sets the value of max event loop execute time, in link. The default value of linkis |
|
Set the time unit of |
||
|
Sets the value of max worker execute time, in link. The default value of link is |
|
Set the time unit of |
||
|
Set wether to prefer the native transport to the JDK transport. |
|
|
Set the quorum size to be used when HA is enabled. |
|
|
Set the threshold value above this, the blocked warning contains a stack trace. in link. The default value of link is |
|
Set the time unit of |
||
|
Set the maximum number of worker threads to be used by the Vert.x instance. |
VertxPrometheusOptions
Name |
Type |
Description |
|
Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics. |
|
|
Set true to enable Prometheus reporting |
|
|
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. |
|
|
When true, an embedded server will init to expose metrics with Prometheus format. |
WebAuthnCredentials
WebAuthnOptions
Name |
Type |
Description |
- |
||
- |
||
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
- |
WebClientOptions
Name |
Type |
Description |
|
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:
|
|
|
Set the connect timeout |
|
|
Add a CRL path |
|
|
Add a CRL value |
|
|
set to |
|
|
Set the default host name to be used by this client in requests if none is provided when making the request. |
|
|
Set the default port to be used by this client in requests if none is provided when making the request. |
|
|
Add an enabled cipher suite, appended to the ordered suites. |
|
|
Sets the list of enabled SSL/TLS protocols. |
|
|
Configure the default behavior of the client to follow HTTP |
|
|
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to |
|
|
Set to |
|
|
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.
|
|
|
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 of0 means there is no timeout.
|
|
|
Set the maximum pool size for HTTP/2 connections |
|
|
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.
|
|
|
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 |
|
Set the idle timeout unit. If not specified, default is seconds. |
||
|
Set whether keep alive is enabled on the client |
|
|
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 of0 means there is no timeout.
|
|
|
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. |
|
|
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
|
|
Set the maximum HTTP chunk size |
|
|
Set the maximum length of all headers for HTTP/1.x . |
|
|
Set the maximum length of the initial line for HTTP/1.x (e.g. |
|
|
Set the maximum pool size for connections |
|
|
Set to |
|
|
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. |
|
|
Set the max WebSocket frame size |
|
|
Set the max WebSocket message size |
|
|
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name. |
|
|
Set whether pipe-lining is enabled on the client |
|
|
Set the limit of pending requests a pipe-lined HTTP/1 connection can send. |
|
|
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. |
|
Set the protocol version. |
||
|
Set the TCP receive buffer size |
|
|
Set the value of reuse address |
|
|
Set the value of reuse port. This is only supported by native transports. |
|
|
Set the TCP send buffer size |
|
|
Set
You may want to set it
It's |
|
|
Set whether SO_linger keep alive is enabled |
|
|
Set whether SSL/TLS is enabled |
|
|
Set the SSL handshake timeout, default time unit is seconds. |
|
Set the SSL handshake timeout unit. If not specified, default is seconds. |
||
|
Enable the |
|
|
Enable the |
|
|
Set whether TCP keep alive is enabled |
|
|
Set whether TCP no delay is enabled |
|
|
Enable the |
|
|
Set the value of traffic class |
|
|
Set whether all server certificates should be trusted |
|
|
Set whether compression is enabled |
|
|
Set whether the client will offer the WebSocket per-frame deflate compression extension. |
|
|
Set whether the client will offer the WebSocket per-message deflate compression extension. |
|
|
||
|
Set the ALPN usage. |
|
|
Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>. |
|
|
Sets whether the Web Client should send a user agent header. Defaults to true. |
|
|
Set whether hostname verification is enabled |
|
|
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 |
|
|
Set whether the |
|
|
Set the WebSocket deflate compression level. |
|
|
Set whether the |
WebSocketConnectOptions
Name |
Type |
Description |
|
Parse an absolute URI to use, this will update the |
|
|
Set whether to follow HTTP redirect |
|
|
Add a request header. |
|
|
Set the host name to be used by the client request. |
|
|
Set the port to be used by the client request. |
|
|
Set whether SSL/TLS is enabled. |
|
|
Set the WebSocket sub protocols to use. |
|
|
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. |
|
|
Set the request relative URI. |
|
Set the WebSocket version. |