Vert.x

https://vertx.io/docs/apidocs/
Admin
Vert.x is an event-driven, non-blocking, polyglot runtime for building reactive and scalable...
Tokens:2,187,705
Snippets:27,216
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### start

Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQClient.html

Starts the RabbitMQ client service.

```APIDOC
## start

### Description
Start the rabbitMQ client.

### Method
`Future<Void>`
```

--------------------------------

### start

Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQPublisher.html

Starts the RabbitMQ publisher. It is expected that the underlying RabbitMQClient has already been started.

```APIDOC
## start

### Description
Start the rabbitMQ publisher. The RabbitMQClient should have been started before this.

### Method
Future<Void>

### Returns
- Future<Void> - A Future that completes when the publisher has been successfully started.
```

--------------------------------

### start()

Source: https://vertx.io/docs/apidocs/io/vertx/ext/shell/ShellService.html

Starts the shell service asynchronously.

```APIDOC
## start()

### Description
Start the shell service. This is an asynchronous operation.

### Method
instance

### Returns
(Future<Void>) - A Future that completes when the service has been started.
```

--------------------------------

### start

Source: https://vertx.io/docs/apidocs/io/vertx/servicediscovery/consul/ConsulServiceImporter.html

Starts the ConsulServiceImporter, registering it with the ServicePublisher.

```APIDOC
## start

### Description
Starts the importer. This method is called by the Vert.x framework to initialize the importer and begin publishing services.

### Method
`start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> completion)`

### Parameters
* `vertx` (Vertx) - The Vert.x instance.
* `publisher` (ServicePublisher) - The service publisher instance.
* `configuration` (JsonObject) - The bridge configuration, if any.
* `completion` (Promise<Void>) - A future on which the bridge must report the completion of the starting process.
```

--------------------------------

### rxStart

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQClient.html

Start the RabbitMQ client.

```APIDOC
## rxStart

### Description
Start the RabbitMQ client.

### Method
APIDOC

### Endpoint
APIDOC
```

--------------------------------

### start (with Promise)

Source: https://vertx.io/docs/apidocs/io/vertx/core/AbstractVerticle.html

Start the verticle. This is called by Vert.x when the verticle instance is deployed. Don't call it yourself.

```APIDOC
## start

### Description
Start the verticle. This is called by Vert.x when the verticle instance is deployed. Don't call it yourself. If your verticle does things in its startup which take some time then you can override this method and call the startFuture some time later when start up is complete.

### Method
public void start(Promise<Void> startPromise)

### Parameters
#### Path Parameters
- **startPromise** (Promise<Void>) - a promise which should be called when verticle start-up is complete.

### Throws
- Exception
```

--------------------------------

### start

Source: https://vertx.io/docs/apidocs/io/vertx/servicediscovery/docker/DockerLinksServiceImporter.html

Starts the importer. This method is called to begin the service discovery process.

```APIDOC
## start

### Description
Starts the importer. This method is called to begin the service discovery process, analyzing environment variables for Docker links.

### Method
`start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> completion)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- `completion` (Promise<Void>) - A future on which the bridge must report the completion of the starting.

#### Response Example
None
```

--------------------------------

### Start StompServer

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/stomp/class-use/StompServer.html

Methods for starting the StompServer and making it listen for connections.

```APIDOC
## StompServer.listen

### Description
Connects the STOMP server to the default port (61613) and network interface (`0.0.0.0`).

### Method
`Future<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

## StompServer.listen

### Description
Connects the STOMP server to the given port.

### Method
`Future<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

## StompServer.listen

### Description
Connects the STOMP server to the given port and interface.

### Method
`Future<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

## StompServer.rxListen

### Description
Connects the STOMP server to the default port (61613) and network interface (`0.0.0.0`) using RxJava.

### Method
`Single<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

## StompServer.rxListen

### Description
Connects the STOMP server to the given port using RxJava.

### Method
`Single<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

## StompServer.rxListen

### Description
Connects the STOMP server to the given port and interface using RxJava.

### Method
`Single<StompServer>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None
```

--------------------------------

### Start Watch

Source: https://vertx.io/docs/apidocs/io/vertx/ext/consul/Watch.html

Start this Watch. This will begin monitoring for updates.

```APIDOC
## Start Watch

### Description
Start this Watch. This will begin monitoring for updates.

### Method
Watch<T> start()

### Response
#### Success Response
- **Watch<T>** - the Watch instance
```

--------------------------------

### Start MqttServer Listening

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/mqtt/class-use/MqttServer.html

Methods to start the MQTT server listening for incoming connections on specified ports and hosts.

```APIDOC
## Start MqttServer Listening

### Description
Methods to start the MQTT server listening for incoming connections on specified ports and hosts.

### Methods

#### `Single<MqttServer> listen()`
Start the server listening for incoming connections using the specified options through the constructor.

#### `Single<MqttServer> listen(int port)`
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.

#### `Single<MqttServer> listen(int port, String host)`
Start the server listening for incoming connections on the port and host specified.

#### `Single<MqttServer> rxListen()`
Start the server listening for incoming connections using the specified options through the constructor (RxJava3 version).

#### `Single<MqttServer> rxListen(int port)`
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host (RxJava3 version).

#### `Single<MqttServer> rxListen(int port, String host)`
Start the server listening for incoming connections on the port and host specified (RxJava3 version).

```

--------------------------------

### KubernetesServiceImporter Start

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html

Start method for KubernetesServiceImporter, which takes a Vertx instance.

```APIDOC
## KubernetesServiceImporter Start

### Description
Start method for KubernetesServiceImporter, which takes a Vertx instance.

### Method
`void start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> completion)`
```

--------------------------------

### Start server listening (specific port and host)

Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttServer.html

Starts the MQTT server listening for incoming connections on the specified host and port. This method returns a Future that completes when the server has started listening.

```APIDOC
## listen(int port, String host)

### Description
Start the server listening for incoming connections on the port and host specified.

### Method
Future<MqttServer>

### Parameters
#### Path Parameters
- **port** (int) - The port number to listen on.
- **host** (String) - The host address to bind to.

### Response
#### Success Response (200)
- **MqttServer** (MqttServer) - A reference to the MqttServer instance after it has started listening.
```

--------------------------------

### Start server listening (default host)

Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttServer.html

Starts the MQTT server listening for incoming connections on all available network interfaces using the port specified during server creation or default options. This method returns a Future that completes when the server has started listening.

```APIDOC
## listen()

### Description
Start the server listening for incoming connections using the specified options through the constructor.

### Method
Future<MqttServer>

### Response
#### Success Response (200)
- **MqttServer** (MqttServer) - A reference to the MqttServer instance after it has started listening.
```

--------------------------------

### start

Source: https://vertx.io/docs/apidocs/io/vertx/lang/groovy/ScriptVerticle.html

Starts the verticle instance. This method is called by Vert.x during deployment.

```APIDOC
## start

### Description
Starts the verticle instance. This method is invoked by the Vert.x framework when the verticle is deployed. The implementation should complete the provided `Promise` upon successful completion or failure.

### Method
`void start(Promise<Void> startPromise)`

### Parameters
* **startPromise** (Promise<Void>) - A promise that should be completed when the verticle has started successfully or failed.

### Throws
* `Exception`
```

--------------------------------

### Server Instantiation

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/openapi/contract/class-use/Server.html

Demonstrates how to create a new instance of Server.

```APIDOC
## Server.newInstance

### Description
Creates a new instance of the Server class.

### Method
`static Server`

### Parameters
- `arg` (Server) - Required - An existing Server instance to base the new instance on.
```

--------------------------------

### Create GraphiQLHandler with default options

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/web/handler/graphql/GraphiQLHandler.html

Creates a new GraphiQLHandler with default GraphiQLHandlerOptions. This is a convenient way to get started with GraphiQL.

```APIDOC
## static GraphiQLHandler create(Vertx vertx)

### Description
Create a new `GraphiQLHandler`.
The handler will be configured with default `GraphiQLHandlerOptions`.

### Method
static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response
- `GraphiQLHandler` - The created GraphiQLHandler instance.

### Response Example
```json
{
  "example": "GraphiQLHandler instance"
}
```
```

--------------------------------

### Create TotpAuth with default options

Source: https://vertx.io/docs/apidocs/io/vertx/ext/auth/otp/totp/class-use/TotpAuth.html

Creates an instance of TotpAuth with default configuration. This is the simplest way to get started with TOTP authentication.

```APIDOC
## TotpAuth.create()

### Description
Creates an instance of TotpAuth with default configuration.

### Method
static TotpAuth

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
- **TotpAuth** (TotpAuth) - A new instance of TotpAuth.
```

--------------------------------

### Create NetServer with Options

Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/NetServerOptions.html

Demonstrates how to create a TCP/SSL server using NetServerOptions.

```APIDOC
## Vertx.createNetServer(NetServerOptions options)

### Description
Create a TCP/SSL server using the specified options.

### Method
`createNetServer`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
NetServerOptions options = new NetServerOptions()
  .setPort(8080)
  .setHost("localhost");
NetServer server = vertx.createNetServer(options);
```

### Response
#### Success Response (200)
`NetServer` instance

#### Response Example
```java
// Server is created and ready to accept connections
```
```

--------------------------------

### Create RockerTemplateEngine with Defaults

Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/templ/rocker/class-use/RockerTemplateEngine.html

Creates a new instance of RockerTemplateEngine using the default configuration. This is the simplest way to get started with Rocker templating.

```APIDOC
## RockerTemplateEngine.create()

### Description
Create a template engine using defaults.

### Method
`static RockerTemplateEngine`

### Endpoint
N/A (SDK Method)

### Parameters
None

### Response
- **RockerTemplateEngine** (object) - A new instance of RockerTemplateEngine.
```

--------------------------------

### rxStart

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQPublisher.html

Starts the RabbitMQ publisher using RxJava.

```APIDOC
## rxStart

### Description
Start the rabbitMQ publisher.

### Method
rxStart

### Returns
A Completable that completes when the publisher has started.
```

--------------------------------

### Create WebSocketClient with default options

Source: https://vertx.io/docs/apidocs/io/vertx/core/http/class-use/WebSocketClient.html

Creates a WebSocket client using the default configuration. This is a convenient way to get started with WebSocket communication.

```APIDOC
## Vertx.createWebSocketClient()

### Description
Creates a WebSocket client using default options.

### Method
```
default WebSocketClient
```

### Endpoint
N/A (SDK method)

### Parameters
None
```

--------------------------------

### rxStart

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/AbstractVerticle.html

Override to return a Completable that will complete the deployment of this verticle. When null is returned, the AbstractVerticle.start() will be called instead.

```APIDOC
## rxStart

### Description
Override to return a `Completable` that will complete the deployment of this verticle. When `null` is returned, the `AbstractVerticle.start()` will be called instead.

### Method
`Completable rxStart()`

### Returns
- `Completable` - the completable
```

--------------------------------

### Setup Callback for Credential Get (Assertion)

Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/handler/WebAuthn4JHandler.html

Configures the callback route for creating login attestations. This is used when a user logs in with an existing authenticator.

```APIDOC
## setupCredentialsGetCallback

```java
WebAuthn4JHandler setupCredentialsGetCallback(Route route)
```

### Description
The callback route to create login attestations. Usually this route is ```
/webauthn/login
```

### Parameters
#### Path Parameters
- **route** (Route) - the route where credential get options are generated.

### Returns
fluent self.
```

--------------------------------

### getRebalanceDelay

Source: https://vertx.io/docs/apidocs/io/vertx/spi/cluster/ignite/IgniteCacheOptions.html

Gets the delay in milliseconds before rebalancing starts automatically after a node joins or leaves the topology. This method is deprecated and users should use the baseline topology feature instead.

```APIDOC
## getRebalanceDelay

### Description
Gets delay in milliseconds upon a node joining or leaving topology (or crash) after which rebalancing should be started automatically. Rebalancing should be delayed if you plan to restart nodes after they leave topology, or if you plan to start multiple nodes at once or one after another and don't want to repartition and rebalance until all nodes are started. For better efficiency user should usually make sure that new nodes get placed on the same place of consistent hash ring as the left nodes, and that nodes are restarted before this delay expires. As an example, node IP address and port combination may be used in this case. Default value is `0` which means that repartitioning and rebalancing will start immediately upon node leaving topology. If `-1` is returned, then rebalancing will only be started manually by calling rebalance() method or from management console.

### Method
GET

### Endpoint
/rebalanceDelay

### Returns
- **long**: Rebalancing delay, `0` to start rebalancing immediately, `-1` to start rebalancing manually, or positive value to specify delay in milliseconds after which rebalancing should start automatically.
```

--------------------------------

### NetServer.listen

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Future.html

Methods to start listening on a NetServer.

```APIDOC
## NetServer.listen(int port, String host)

### Description
Start listening on the specified port and host, ignoring port and host configured in the NetServerOptions used when creating the server.

### Return Type
Future<NetServer>
```

```APIDOC
## NetServer.listen(SocketAddress localAddress)

### Description
Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

### Return Type
Future<NetServer>
```

--------------------------------

### rxListen (no args)

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/net/NetServer.html

Start listening on the port and host as configured in the NetServerOptions used when creating the server. The server may not be listening until some time after the call to listen has returned.

```APIDOC
## rxListen

### Description
Start listening on the port and host as configured in the `NetServerOptions` used when creating the server. The server may not be listening until some time after the call to `rxListen` has returned.

### Method
`Single<NetServer>`

### Returns
- **Single<NetServer>** - A future completed with the listen operation result.
```

--------------------------------

### Create KubeResolver with default options

Source: https://vertx.io/docs/apidocs/io/vertx/serviceresolver/kube/class-use/KubeResolver.html

Creates a new instance of KubeResolver using default configuration options. This is the simplest way to get started with the Kubernetes service resolver.

```APIDOC
## KubeResolver.create()

### Description
Create a Kubernetes resolver with the default options.

### Method
static

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **KubeResolver** - An instance of KubeResolver.

### Response Example
```json
{
  "example": "KubeResolver instance"
}
```
```

--------------------------------

### listen

Source: https://vertx.io/docs/apidocs/io/vertx/core/net/QuicServer.html

Start listening on the port and host as configured in the QuicServerConfig used when creating the server.

```APIDOC
## listen

### Description
Start listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server.

### Method
`Future<SocketAddress>`

### Returns
* `Future<SocketAddress>` - A future that completes with the listening socket address.
```

--------------------------------

### ShellServer.listen

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Future.html

Starts the shell service.

```APIDOC
## ShellServer.listen()

### Description
Start the shell service, this is an asynchronous start.

### Return Type
Future<Void>
```

--------------------------------

### Create MqttServer with options

Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/MqttServer.html

Creates an MqttServer instance with specified options.

```APIDOC
## create(Vertx vertx, MqttServerOptions options)

### Description
Returns an MQTT server instance configured with the provided options.

### Method
static MqttServer

### Parameters
* **vertx** (Vertx) - The Vert.x instance.
* **options** (MqttServerOptions) - The MQTT server options.

### Returns
MqttServer - An instance of the MQTT server.
```

--------------------------------

### ShellVerticle start method

Source: https://vertx.io/docs/apidocs/io/vertx/ext/shell/ShellVerticle.html

Starts the ShellVerticle. This method is called by Vert.x during deployment and should not be invoked directly. It allows for asynchronous startup by completing the provided Promise.

```APIDOC
## start(Promise<Void> startFuture)

### Description
Starts the verticle. This is called by Vert.x when the verticle instance is deployed. Don't call it yourself. If your verticle does things in its startup which take some time then you can override this method and call the startFuture some time later when start up is complete.

### Method
`void start(Promise<Void> startFuture)`

### Parameters
#### Parameters
- **startFuture** (Promise<Void>) - A promise which should be called when verticle start-up is complete.

### Throws
- `Exception`
```

--------------------------------

### Start Listening

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/eventbus/bridge/tcp/TcpEventBusBridge.html

Methods to start the TCP Event Bus Bridge, with options to specify port, address, or use configured options.

```APIDOC
## Start Listening

Methods to start the TCP Event Bus Bridge, with options to specify port, address, or use configured options.

### listen

Starts listening on the port and host as configured in the `NetServerOptions`. Returns a future of the result.

#### Method

```
public Future<TcpEventBusBridge> listen()
```

### rxListen

RxJava equivalent of `listen()`. Starts listening on the port and host as configured in the `NetServerOptions`. Returns a Single of the result.

#### Method

```
public Single<TcpEventBusBridge> rxListen()
```

### listen

Starts listening on the specified port and host, ignoring port and host configured in the `NetServerOptions`. Returns a future of the result.

#### Parameters

- **port** (int) - the tcp port
- **address** (String) - the local address

#### Method

```
public Future<TcpEventBusBridge> listen(int port, String address)
```

### rxListen

RxJava equivalent of `listen(int, String)`. Starts listening on the specified port and host. Returns a Single of the result.

#### Parameters

- **port** (int) - the tcp port
- **address** (String) - the local address

#### Method

```
public Single<TcpEventBusBridge> rxListen(int port, String address)
```

### listen

Starts listening on the specified port and host "0.0.0.0", ignoring port and host configured in the `NetServerOptions`. Returns a future of the result.

#### Parameters

- **port** (int) - the TCP port

#### Method

```
public Future<TcpEventBusBridge> listen(int port)
```

### rxListen

RxJava equivalent of `listen(int)`. Starts listening on the specified port and host "0.0.0.0". Returns a Single of the result.

#### Parameters

- **port** (int) - the TCP port

#### Method

```
public Single<TcpEventBusBridge> rxListen(int port)
```

### listen

Starts listening on the specified local address, ignoring port and host configured in the `NetServerOptions`. Returns a future of the result.

#### Parameters

- **localAddress** (SocketAddress) - the local address to listen on

#### Method

```
public Future<TcpEventBusBridge> listen(SocketAddress localAddress)
```

### rxListen

RxJava equivalent of `listen(SocketAddress)`. Starts listening on the specified local address. Returns a Single of the result.

#### Parameters

- **localAddress** (SocketAddress) - the local address to listen on

#### Method

```
public Single<TcpEventBusBridge> rxListen(SocketAddress localAddress)
```
```

--------------------------------

### listen (no args)

Source: https://vertx.io/docs/apidocs/io/vertx/core/net/QuicServer.html

Starts listening on the port and host configured in the QuicServerConfig used when creating the server.

```APIDOC
## listen

### Description
Starts listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server.

### Method
`Future<SocketAddress> listen()`

### Returns
- `Future<SocketAddress>` - A future signaling the success or failure of the listen operation. The result is the socket address this endpoint is bound to.
```

--------------------------------

### start (synchronous)

Source: https://vertx.io/docs/apidocs/io/vertx/core/AbstractVerticle.html

If your verticle does a simple, synchronous start-up then override this method and put your start-up code in here.

```APIDOC
## start

### Description
If your verticle does a simple, synchronous start-up then override this method and put your start-up code in here.

### Method
public void start() throws Exception

### Throws
- Exception
```

--------------------------------

### FreeMarkerTemplateEngine Instance Creation from Existing

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/web/templ/freemarker/class-use/FreeMarkerTemplateEngine.html

Shows how to create a new FreeMarkerTemplateEngine instance based on an existing one.

```APIDOC
## FreeMarkerTemplateEngine.newInstance

### Description
Creates a new FreeMarkerTemplateEngine instance, potentially for use in different contexts or with modified configurations, based on an existing engine.

### Method
`static FreeMarkerTemplateEngine newInstance(FreeMarkerTemplateEngine arg)`

### Parameters
* **arg** (FreeMarkerTemplateEngine) - An existing FreeMarkerTemplateEngine instance to base the new one on.
```

--------------------------------

### Get Delegate

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/consul/ConsulClient.html

Get the delegate object.

```APIDOC
## getDelegate

### Description
Get the delegate object.

### Method
Instance Method

### Returns
- **ConsulClient** - The delegate Consul client.
```

--------------------------------

### Creating NetClient Instances

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/net/class-use/NetClient.html

Demonstrates various ways to create a NetClient instance using Vert.x.

```APIDOC
## Vertx.createNetClient()

### Description
Creates a TCP/SSL client using default options.

### Method
`createNetClient`

### Parameters
None

## Vertx.createNetClient(NetClientOptions options)

### Description
Creates a TCP/SSL client using the specified options.

### Method
`createNetClient`

### Parameters
#### Query Parameters
- **options** (NetClientOptions) - Required - The options to configure the NetClient.

## Vertx.createNetClient(TcpClientConfig config)

### Description
Creates a TCP/SSL client using the specified config.

### Method
`createNetClient`

### Parameters
#### Query Parameters
- **config** (TcpClientConfig) - Required - The configuration to set up the NetClient.

## Vertx.createNetClient(TcpClientConfig config, ClientSSLOptions sslOptions)

### Description
Creates a TCP/SSL client using the specified config and the specified SSL options.

### Method
`createNetClient`

### Parameters
#### Query Parameters
- **config** (TcpClientConfig) - Required - The configuration to set up the NetClient.
- **sslOptions** (ClientSSLOptions) - Required - The SSL options to apply to the NetClient.
```

--------------------------------

### Getting ListServicesResponse

Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ServerReflectionResponse.Builder.html

Method for getting the list_services_response field.

```APIDOC
## getListServicesResponse

### Description
Returns the list_services_response field. This message is used to answer list_services requests.

### Method
public ListServiceResponse getListServicesResponse()

### Returns
The list_services_response.
```

--------------------------------

### Add a route for any HTTP GET request

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/web/Router.html

Adds a route that will handle any incoming HTTP GET requests. This is a convenient shortcut for defining GET routes.

```APIDOC
## get

### Description
Add a route that matches any HTTP GET request

### Method
Route

### Returns
- Route - the route
```

--------------------------------

### Create NetClient with Options

Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/NetClientOptions.html

Demonstrates how to create a TCP/SSL client using the Vert.x API with provided NetClientOptions.

```APIDOC
## Vertx.createNetClient(NetClientOptions options)

### Description
Creates a TCP/SSL client using the specified options.

### Method
`NetClient`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
NetClient netClient = vertx.createNetClient(options);
```

### Response
#### Success Response (200)
- **netClient** (NetClient) - The created NetClient instance.

#### Response Example
```java
// Example of a NetClient instance
NetClient netClient = ...;
```
```

--------------------------------

### create

Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQClient.html

Create and return a client with the specified configuration.

```APIDOC
## create

### Description
Create and return a client with the specified configuration.

### Method
static RabbitMQClient create(Vertx vertx, RabbitMQOptions config)

### Parameters
#### Path Parameters
- **vertx** (Vertx) - the vertx instance
- **config** (RabbitMQOptions) - the client config

### Returns
the client
```

--------------------------------

### GET Request Routing

Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/Router.html

Adds a route that specifically matches HTTP GET requests. Supports matching any GET request or requests to a specific path.

```APIDOC
## get

### Description
Add a route that matches any HTTP GET request or a specific path.

### Method
Route

### Signature
get()
get(String path)
```

--------------------------------

### main

Source: https://vertx.io/docs/apidocs/io/vertx/core/Launcher.html

Main entry point for the application. This method is the starting point for executing a Vert.x application.

```APIDOC
## main

### Description
Main entry point for the application. This method is the starting point for executing a Vert.x application.

### Method
public static void main(String[] args)

### Parameters
#### Path Parameters
- **args** (String[]) - The user command line arguments.
```

--------------------------------

### Start Watch

Source: https://vertx.io/docs/apidocs/io/vertx/ext/consul/Watch.html

Starts the watch and begins monitoring for changes.

```APIDOC
## Watch.start
Watch<T> start()

### Description
Start this `Watch`

### Returns
reference to this, for fluency
```

--------------------------------

### deploy

Source: https://vertx.io/docs/apidocs/io/vertx/core/AbstractVerticle.html

Start the deployable. Vert.x calls this method when deploying this deployable. You do not call it yourself.

```APIDOC
## deploy

### Description
Start the deployable. Vert.x calls this method when deploying this deployable. You do not call it yourself.

### Method
public final Future<?> deploy(Context context)

### Parameters
#### Path Parameters
- **context** (Context) - the Vert.x context assigned to this deployable

### Returns
a future signalling the start-up completion
```

--------------------------------

### Get ACL Tokens

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/consul/ConsulClient.html

Get list of Acl token.

```APIDOC
## getAclTokens

### Description
Get list of Acl token.

### Method
GET

### Endpoint
/v1/acl/tokens

### Parameters
#### Query Parameters
- **dc** (String) - Optional - The datacenter to query.

### Response
#### Success Response (200)
- **aclTokens** (List<AclToken>) - A list of ACL tokens.

#### Response Example
```json
[
  {
    "AccessorID": "accessor-id-456",
    "Secret": "secret-token-789",
    "LocalSeq": 1,
    "CreateTime": "2023-10-27T10:00:00Z",
    "ModifyTime": "2023-10-27T10:00:00Z",
    "Name": "my-token",
    "Policies": [
      { "ID": "policy-id-123", "Name": "my-policy" }
    ]
  }
]
```
```

--------------------------------

### ServiceImporter start

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/class-use/Vertx.html

Starts the ServiceImporter with Vertx, publisher, configuration, and a future.

```APIDOC
## ServiceImporter start

### Description
Starts the importer by initializing it with the `Vertx` instance, `ServicePublisher`, `JsonObject` configuration, and a `Promise<Void>`.

### Method
`void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
None

#### Response Example
None
```

--------------------------------

### create

Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQClient.html

Create and return a client configured with the default options.

```APIDOC
## create

### Description
Create and return a client configured with the default options.

### Method
static RabbitMQClient create(Vertx vertx)

### Parameters
#### Path Parameters
- **vertx** (Vertx) - the vertx instance

### Returns
the client
```

--------------------------------

### Cassandra Client Creation with Options

Source: https://vertx.io/docs/apidocs/io/vertx/cassandra/class-use/CassandraClientOptions.html

Demonstrates how to create Cassandra clients, both standalone and shared, using CassandraClientOptions.

```APIDOC
## Cassandra Client Creation

### Description
Methods to create `CassandraClient` instances using `CassandraClientOptions`.

### Methods

#### `static CassandraClient create(Vertx vertx, CassandraClientOptions options)`
Create a Cassandra client which maintains its own driver session.

#### `static CassandraClient createShared(Vertx vertx, CassandraClientOptions options)`
Like `CassandraClient.createShared(Vertx, String, CassandraClientOptions)` with default client name.

#### `static CassandraClient createShared(Vertx vertx, String clientName, CassandraClientOptions options)`
Create a Cassandra client that shares its driver session with any other client having the same name.
```

--------------------------------

### listen

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/net/QuicServer.html

Start listening on the configured port and host.

```APIDOC
## listen (no parameters)

### Description
Start listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server.

### Method
public Future<SocketAddress> listen()

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## listen (port, host)

### Description
Start listening on the specified `port` and `host`. Port `0` can be specified meaning "choose a random port". Host `0.0.0.0` can be specified meaning "listen on all available interfaces".

### Method
public Future<SocketAddress> listen(int port, String host)

### Parameters
#### Path Parameters
- **port** (int) - 
- **host** (String) - 

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## listen (port)

### Description
Start listening on the specified port and host "0.0.0.0". Port `0` can be specified meaning "choose an random port".

### Method
public Future<SocketAddress> listen(int port)

### Parameters
#### Path Parameters
- **port** (int) - 

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## listen (localAddress)

### Description
Start listening on the specified local address.

### Method
public Future<SocketAddress> listen(SocketAddress localAddress)

### Parameters
#### Path Parameters
- **localAddress** (SocketAddress) - the local address to listen on

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

--------------------------------

### ServiceImporter Start

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html

Start method for ServiceImporter, which takes a Vertx instance.

```APIDOC
## ServiceImporter Start

### Description
Start method for ServiceImporter, which takes a Vertx instance.

### Method
`void start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> future)`
```

--------------------------------

### Create DNS Client with Options

Source: https://vertx.io/docs/apidocs/io/vertx/core/dns/class-use/DnsClientOptions.html

Demonstrates how to create a DNS client using DnsClientOptions.

```APIDOC
## Vertx.createDnsClient(DnsClientOptions options)

### Description
Create a DNS client to connect to a DNS server using the provided options.

### Method
Vertx.createDnsClient

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
DnsClientOptions options = new Dns.DnsClientOptions()
  .setHost("8.8.8.8")
  .setPort(53)
  .setQueryTimeout(5000);
DnsClient client = vertx.createDnsClient(options);
```

### Response
#### Success Response
- **DnsClient** (DnsClient) - An instance of DnsClient configured with the provided options.

#### Response Example
```java
// DnsClient instance is returned
```
```

--------------------------------

### DockerLinksServiceImporter Start

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html

Start method for DockerLinksServiceImporter, which takes a Vertx instance.

```APIDOC
## DockerLinksServiceImporter Start

### Description
Start method for DockerLinksServiceImporter, which takes a Vertx instance.

### Method
`void start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> completion)`
```

--------------------------------

### HttpClient Instantiation

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/http/class-use/HttpClient.html

Demonstrates how to create a new instance of HttpClient.

```APIDOC
## HttpClient.newInstance

### Description
Creates a new HttpClient instance.

### Method
static HttpClient

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **HttpClient** (HttpClient) - A new HttpClient instance.

#### Response Example
None
```

--------------------------------

### ConsulServiceImporter Start

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html

Start method for ConsulServiceImporter, which takes a Vertx instance.

```APIDOC
## ConsulServiceImporter Start

### Description
Start method for ConsulServiceImporter, which takes a Vertx instance.

### Method
`void start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise<Void> completion)`
```

--------------------------------

### start

Source: https://vertx.io/docs/apidocs/io/vertx/camel/CamelBridge.html

Starts the CamelBridge asynchronously. This method should be called after the bridge has been created.

```APIDOC
## start

### Description
Starts the bridge. The bridge is started asynchronously.

### Method
Future<Void>

### Returns
* **Future<Void>** - A future notified when the bridge has started.
```

--------------------------------

### newInstance

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/file/FileSystem.html

Creates a new instance of FileSystem.

```APIDOC
## newInstance

### Description
Creates a new instance of FileSystem.

### Method
`static FileSystem newInstance(FileSystem arg)`

### Parameters
* `arg` (FileSystem) - The FileSystem instance to use

### Returns
A new FileSystem instance
```

--------------------------------

### HTTP GET Request

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/web/client/WebClient.html

Methods to create an HTTP GET request.

```APIDOC
## HTTP GET Request

### Description
Methods to create an HTTP GET request.

### Instance Methods

`HttpRequest<Buffer> get(int port, String host, UriTemplate requestURI)`
Create an HTTP GET request to send to the server at the specified host and port.

`HttpRequest<Buffer> get(int port, String host, String requestURI)`
Create an HTTP GET request to send to the server at the specified host and port.

`HttpRequest<Buffer> get(UriTemplate requestURI)`
Create an HTTP GET request to send to the server at the default host and port.

`HttpRequest<Buffer> get(String requestURI)`
Create an HTTP GET request to send to the server at the default host and port.

`HttpRequest<Buffer> get(String host, UriTemplate requestURI)`
Create an HTTP GET request to send to the server at the specified host and default port.

`HttpRequest<Buffer> get(String host, String requestURI)`
Create an HTTP GET request to send to the server at the specified host and default port.

`HttpRequest<Buffer> getAbs(UriTemplate absoluteURI)`
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response

`HttpRequest<Buffer> getAbs(String absoluteURI)`
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
```

--------------------------------

### StompServer Creation with Options

Source: https://vertx.io/docs/apidocs/io/vertx/ext/stomp/class-use/StompServerOptions.html

Demonstrates how to create a StompServer instance using StompServerOptions.

```APIDOC
## StompServer Creation

### Description
Methods to create a `StompServer` using provided `Vertx` and `StompServerOptions`.

### Methods

- **`static StompServer create(Vertx vertx, StompServerOptions options)`**
  Creates a `StompServer` based on the default Stomp Server implementation.

- **`static StompServer create(Vertx vertx, NetServer net, StompServerOptions options)`**
  Creates a `StompServer` based on the default Stomp Server implementation, using a provided `NetServer`.
```

--------------------------------

### newInstance

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/mqtt/MqttServer.html

Creates a new instance of MqttServer.

```APIDOC
## newInstance

### Description
Creates a new instance of MqttServer.

### Method
public static MqttServer newInstance(MqttServer arg)

### Parameters
#### Path Parameters
- **arg** (MqttServer) - Description not provided.
```

--------------------------------

### Getting ListServicesResponse OrBuilder

Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ServerReflectionResponse.Builder.html

Method for getting an OrBuilder for the list_services_response field.

```APIDOC
## getListServicesResponseOrBuilder

### Description
Returns an OrBuilder for the list_services_response field.

### Method
public ListServiceResponseOrBuilder getListServicesResponseOrBuilder()

### Returns
A ListServiceResponseOrBuilder.
```

--------------------------------

### Getting ListServicesResponse Builder

Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ServerReflectionResponse.Builder.html

Method for getting a builder for the list_services_response field.

```APIDOC
## getListServicesResponseBuilder

### Description
Returns a builder for the list_services_response field.

### Method
public ListServiceResponse.Builder getListServicesResponseBuilder()

### Returns
A ListServiceResponse.Builder.
```

--------------------------------

### create

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/stomp/StompServer.html

Creates a StompServer with default options.

```APIDOC
## create

### Description
Creates a `StompServer` based on the default Stomp Server implementation, and uses the default options.

### Method
static StompServer

### Parameters
#### Path Parameters
- **vertx** (Vertx) - the vert.x instance to use

### Returns
- the created `StompServer`
```

--------------------------------

### Getting AllExtensionNumbersResponse OrBuilder

Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ServerReflectionResponse.Builder.html

Method for getting an OrBuilder for the all_extension_numbers_response field.

```APIDOC
## getAllExtensionNumbersResponseOrBuilder

### Description
Returns an OrBuilder for the all_extension_numbers_response field.

### Method
public ExtensionNumberResponseOrBuilder getAllExtensionNumbersResponseOrBuilder()

### Returns
An ExtensionNumberResponseOrBuilder.
```

--------------------------------

### ShellServer Creation

Source: https://vertx.io/docs/apidocs/io/vertx/ext/shell/class-use/ShellServerOptions.html

Demonstrates how to create a ShellServer instance using ShellServerOptions.

```APIDOC
## Static Method ShellServer.create

### Description
Create a new shell server with default options or custom options.

### Method Signature
`static ShellServer create(Vertx vertx, ShellServerOptions options)`

### Parameters
* **vertx** (Vertx) - The Vertx instance.
* **options** (ShellServerOptions) - The shell server options.
```

--------------------------------

### rxListen

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/net/QuicServer.html

Start listening using RxJava Single.

```APIDOC
## rxListen (no parameters)

### Description
Start listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server.

### Method
public Single<SocketAddress> rxListen()

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## rxListen (port, host)

### Description
Start listening on the specified `port` and `host`. Port `0` can be specified meaning "choose a random port". Host `0.0.0.0` can be specified meaning "listen on all available interfaces".

### Method
public Single<SocketAddress> rxListen(int port, String host)

### Parameters
#### Path Parameters
- **port** (int) - 
- **host** (String) - 

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## rxListen (port)

### Description
Start listening on the specified port and host "0.0.0.0". Port `0` can be specified meaning "choose an random port".

### Method
public Single<SocketAddress> rxListen(int port)

### Parameters
#### Path Parameters
- **port** (int) - 

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

```APIDOC
## rxListen (localAddress)

### Description
Start listening on the specified local address.

### Method
public Single<SocketAddress> rxListen(SocketAddress localAddress)

### Parameters
#### Path Parameters
- **localAddress** (SocketAddress) - the local address to listen on

### Returns
- a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to
```

--------------------------------

### Getting AllExtensionNumbersResponse Builder

Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ServerReflectionResponse.Builder.html

Method for getting a builder for the all_extension_numbers_response field.

```APIDOC
## getAllExtensionNumbersResponseBuilder

### Description
Returns a builder for the all_extension_numbers_response field.

### Method
public ExtensionNumberResponse.Builder getAllExtensionNumbersResponseBuilder()

### Returns
An ExtensionNumberResponse.Builder.
```

--------------------------------

### Get Delegate (ReactiveX)

Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/handler/class-use/DigestAuthHandler.html

Gets the delegate DigestAuthHandler from the reactive wrapper.

```APIDOC
## getDelegate

### Description
Gets the delegate DigestAuthHandler.

### Method
`DigestAuthHandler`

### Returns
- `DigestAuthHandler` - The delegate DigestAuthHandler.
```

--------------------------------

### Create MqttServer with default options

Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttServer.html

Creates an MQTT server instance using the default options. This is a static factory method.

```APIDOC
## create(Vertx vertx)

### Description
Return an MQTT server instance using default options.

### Method
static

### Parameters
#### Path Parameters
- **vertx** (Vertx) - The Vert.x instance to use.
```

--------------------------------

### Get Delegate QuicClient

Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/QuicClient.html

Gets the underlying delegate QuicClient instance.

```APIDOC
## QuicClient.getDelegate()

### Description
Gets the underlying delegate QuicClient instance.

### Method
`QuicClient`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **QuicClient** (QuicClient) - The delegate QuicClient instance.

#### Response Example
None
```

--------------------------------

### init

Source: https://vertx.io/docs/apidocs/io/vertx/sqlclient/SqlConnectOptions.html

Initializes with default options. This is a protected method.

```APIDOC
## init

### Description
Initialize with the default options.

### Method
protected void init()
```

--------------------------------

### get

Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/shareddata/AsyncMap.html

Get a value from the map asynchronously. Returns a Maybe that will be notified with the result.

```APIDOC
## get

### Description
Get a value from the map asynchronously.

### Method
GET

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **k** (K) - Required - the key

### Response
#### Success Response
- **V** - The value associated with the key, or null if not found.

### Response Example
```json
{
  "example": "value"
}
```
```

--------------------------------

### init

Source: https://vertx.io/docs/apidocs/io/vertx/oracleclient/OracleConnectOptions.html

Initializes the connection options with default values.

```APIDOC
## init

### Description
Initializes with the default options.

### Method
protected void init()

### Returns
None.
```

--------------------------------

### MqttServer create

Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html

Creates an MQTT server instance.

```APIDOC
## MqttServer.create

### Description
Returns an MQTT server instance using default options or specified options.

### Method
`static MqttServer`

### Signature
`create(Vertx vertx)`

### Signature
`create(Vertx vertx, MqttServerOptions options)`
```

--------------------------------

### WriteStreamObserver Usage Examples

Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/class-use/WriteStreamObserver.html

Examples of obtaining WriteStreamObserver from various Vert.x components.

```APIDOC
## WriteStreamObserver Usage Examples

### Description
Demonstrates how to obtain a `WriteStreamObserver` from different Vert.x objects.

### Examples

#### AmqpSender
```java
WriteStreamObserver<AmqpMessage> observer = amqpSender.toObserver();
```

#### AsyncFile
```java
WriteStreamObserver<Buffer> observer = asyncFile.toObserver();
```

#### ClientWebSocket
```java
WriteStreamObserver<Buffer> observer = clientWebSocket.toObserver();
```

#### HttpClientRequest
```java
WriteStreamObserver<Buffer> observer = httpClientRequest.toObserver();
```

#### HttpServerResponse
```java
WriteStreamObserver<Buffer> observer = httpServerResponse.toObserver();
```

#### ServerWebSocket
```java
WriteStreamObserver<Buffer> observer = serverWebSocket.toObserver();
```

#### WebSocket
```java
WriteStreamObserver<Buffer> observer = webSocket.toObserver();
```

#### NetSocket
```java
WriteStreamObserver<Buffer> observer = netSocket.toObserver();
```

#### QuicStream
```java
WriteStreamObserver<Buffer> observer = quicStream.toObserver();
```

#### WriteStream (generic)
```java
WriteStreamObserver<T> observer = writeStream.toObserver();
```

#### SockJSSocket
```java
WriteStreamObserver<Buffer> observer = sockJSSocket.toObserver();
```

#### GrpcClientRequest
```java
WriteStreamObserver<Req> observer = grpcClientRequest.toObserver();
```

#### GrpcWriteStream
```java
WriteStreamObserver<T> observer = grpcWriteStream.toObserver();
```

#### GrpcServerResponse
```java
WriteStreamObserver<Resp> observer = grpcServerResponse.toObserver();
```

#### KafkaProducer
```java
WriteStreamObserver<KafkaProducerRecord<K,V>> observer = kafkaProducer.toObserver();
```
```
Tokens:
Raw