## Uses of Class
io.vertx.core.http.RequestOptions

- Packages that use RequestOptions
  Package | Description
  --- | ---
  io.vertx.core.http |
  io.vertx.ext.web.client |
  io.vertx.reactivex.core.http |
  io.vertx.reactivex.ext.web.client |
  io.vertx.rxjava.core.http |
  io.vertx.rxjava.ext.web.client |
  io.vertx.rxjava3.core.http |
  io.vertx.rxjava3.ext.web.client |

- - ### Uses of RequestOptions in io.vertx.core.http

    Subclasses of RequestOptions in io.vertx.core.http
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `WebSocketConnectOptions` | Options describing how an `HttpClient` connect a `WebSocket`.

    Fields in io.vertx.core.http with type parameters of type RequestOptions
    Modifier and Type | Field | Description
    --- | --- | ---
    `static java.util.function.Function<HttpClientResponse,​Future<RequestOptions>>` | HttpClientAgent.`DEFAULT_REDIRECT_HANDLER` | Constant containing the default redirect handler of used by the client.

    Methods in io.vertx.core.http that return RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `RequestOptions` | RequestOptions.`addHeader​(CharSequence key, CharSequence value)` | Add a request header.
    `RequestOptions` | RequestOptions.`addHeader​(CharSequence key, Iterable<CharSequence> values)` |
    `RequestOptions` | RequestOptions.`addHeader​(String key, String value)` | Add a request header.
    `RequestOptions` | RequestOptions.`putHeader​(CharSequence key, CharSequence value)` | Set a request header.
    `RequestOptions` | RequestOptions.`putHeader​(CharSequence key, Iterable<CharSequence> values)` |
    `RequestOptions` | RequestOptions.`putHeader​(String key, String value)` | Set a request header.
    `RequestOptions` | RequestOptions.`removeHeader​(CharSequence key)` | Add a request header.
    `RequestOptions` | RequestOptions.`removeHeader​(String key)` | Add a request header.
    `RequestOptions` | RequestOptions.`setAbsoluteURI​(String absoluteURI)` | Parse an absolute URI to use, this will update the `ssl`, `host`, `port` and `uri` fields.
    `RequestOptions` | RequestOptions.`setAbsoluteURI​(URL url)` | Like `setAbsoluteURI(String)` but using an `URL` parameter.
    `RequestOptions` | RequestOptions.`setConnectTimeout​(long timeout)` |
    `RequestOptions` | RequestOptions.`setFollowRedirects​(Boolean followRedirects)` | Set whether to follow HTTP redirect
    `RequestOptions` | RequestOptions.`setHeaders​(MultiMap headers)` | Set request headers from a multi-map.
    `RequestOptions` | RequestOptions.`setHost​(String host)` |
    `RequestOptions` | RequestOptions.`setIdleTimeout​(long timeout)` | Sets the amount of time after which, if the request does not return any data within the timeout period, the request/response is closed and the related futures are failed with a `TimeoutException`, e.g.
    `RequestOptions` | RequestOptions.`setMethod​(HttpMethod method)` | Set the HTTP method to be used by the client request.
    `RequestOptions` | RequestOptions.`setPort​(Integer port)` |
    `RequestOptions` | RequestOptions.`setProxyOptions​(ProxyOptions proxyOptions)` |
    `RequestOptions` | WebSocketConnectOptions.`setProxyOptions​(ProxyOptions proxyOptions)` | Override the `HttpClientOptions.setProxyOptions(ProxyOptions)` proxy options for connections.
    `RequestOptions` | RequestOptions.`setRoutingKey​(String key)` | Set the routing key, the routing key can be used by a Vert.x client side sticky load balancer to pin the request to a remote HTTP server.
    `RequestOptions` | RequestOptions.`setServer​(Address server)` |
    `RequestOptions` | RequestOptions.`setSsl​(Boolean ssl)` |
    `RequestOptions` | RequestOptions.`setSslOptions​(ClientSSLOptions sslOptions)` |
    `RequestOptions` | RequestOptions.`setTimeout​(long timeout)` | Sets both connect and idle timeouts for the request connect timeout: if the request is not obtained from the client within the timeout period, the `Future<HttpClientRequest>` obtained from the client is failed with a `TimeoutException`. idle timeout: if the request does not return any data within the timeout period, the request/response is closed and the related futures are failed with a `TimeoutException`, e.g.
    `RequestOptions` | RequestOptions.`setTraceOperation​(String op)` | Override the operation the tracer use for this request.
    `RequestOptions` | RequestOptions.`setURI​(String uri)` | Set the request relative URI.

    Methods in io.vertx.core.http with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<HttpClientRequest>` | HttpClient.`request​(RequestOptions options)` | Create an HTTP request to send to the server.

    Method parameters in io.vertx.core.http with type arguments of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpClientBuilder` | HttpClientBuilder.`withRedirectHandler​(java.util.function.Function<HttpClientResponse,​Future<RequestOptions>> handler)` | Set a redirect handler for the http client.

    Constructors in io.vertx.core.http with parameters of type RequestOptions
    Constructor | Description
    --- | ---
    `RequestOptions​(RequestOptions other)` | Copy constructor

  - ### Uses of RequestOptions in io.vertx.ext.web.client

    Methods in io.vertx.ext.web.client with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `default HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, RequestOptions options)` | Create an HTTP request to send to the server at the specified host and port.
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, SocketAddress serverAddress, RequestOptions options)` | Like `WebClient.request(HttpMethod, RequestOptions)` using the `serverAddress` parameter to connect to the server instead of the `options` parameter.

  - ### Uses of RequestOptions in io.vertx.reactivex.core.http

    Methods in io.vertx.reactivex.core.http with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<HttpClientRequest>` | HttpClient.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Future<HttpClientRequest>` | HttpClientAgent.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Future<HttpClientRequest>` | HttpClientConnection.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClient.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientAgent.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientConnection.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.

    Method parameters in io.vertx.reactivex.core.http with type arguments of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpClientBuilder` | HttpClientBuilder.`withRedirectHandler​(Function<HttpClientResponse,​Single<RequestOptions>> handler)` | Set a redirect handler for the http client.
    `HttpClientBuilder` | HttpClientBuilder.`withRedirectHandler​(java.util.function.Function<HttpClientResponse,​Future<RequestOptions>> handler)` | Set a redirect handler for the http client.

  - ### Uses of RequestOptions in io.vertx.reactivex.ext.web.client

    Methods in io.vertx.reactivex.ext.web.client with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, RequestOptions options)` | Create an HTTP request to send to the server at the specified host and port.
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, SocketAddress serverAddress, RequestOptions options)` | Like `WebClient.request(io.vertx.core.http.HttpMethod, int, java.lang.String, java.lang.String)` using the `serverAddress` parameter to connect to the server instead of the `options` parameter.

  - ### Uses of RequestOptions in io.vertx.rxjava.core.http

    Methods in io.vertx.rxjava.core.http with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<HttpClientRequest>` | HttpClient.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Future<HttpClientRequest>` | HttpClientAgent.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Future<HttpClientRequest>` | HttpClientConnection.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClient.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientAgent.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientConnection.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.

    Method parameters in io.vertx.rxjava.core.http with type arguments of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpClientBuilder` | HttpClientBuilder.`withRedirectHandler​(java.util.function.Function<HttpClientResponse,​Future<RequestOptions>> handler)` | Set a redirect handler for the http client.

  - ### Uses of RequestOptions in io.vertx.rxjava.ext.web.client

    Methods in io.vertx.rxjava.ext.web.client with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, RequestOptions options)` | Create an HTTP request to send to the server at the specified host and port.
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, SocketAddress serverAddress, RequestOptions options)` | Like `WebClient.request(io.vertx.core.http.HttpMethod, int, java.lang.String, java.lang.String)` using the `serverAddress` parameter to connect to the server instead of the `options` parameter.

  - ### Uses of RequestOptions in io.vertx.rxjava3.core.http

    Methods in io.vertx.rxjava3.core.http with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Single<HttpClientRequest>` | HttpClient.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientAgent.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientConnection.`request​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClient.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientAgent.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.
    `Single<HttpClientRequest>` | HttpClientConnection.`rxRequest​(RequestOptions options)` | Create an HTTP request to send to the server.

    Method parameters in io.vertx.rxjava3.core.http with type arguments of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpClientBuilder` | HttpClientBuilder.`withRedirectHandler​(java.util.function.Function<HttpClientResponse,​Single<RequestOptions>> handler)` | Set a redirect handler for the http client.

  - ### Uses of RequestOptions in io.vertx.rxjava3.ext.web.client

    Methods in io.vertx.rxjava3.ext.web.client with parameters of type RequestOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, RequestOptions options)` | Create an HTTP request to send to the server at the specified host and port.
    `HttpRequest<Buffer>` | WebClient.`request​(HttpMethod method, SocketAddress serverAddress, RequestOptions options)` | Like `WebClient.request(io.vertx.core.http.HttpMethod, int, java.lang.String, java.lang.String)` using the `serverAddress` parameter to connect to the server instead of the `options` parameter.