Skip navigation links
A B C D E F G H I J L M O P Q R S T U V W 

A

addCachedMethod(HttpMethod) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Add an HTTP method that is cacheable.
addCachedStatusCode(Integer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Add a status code that is cacheable.
addCrlPath(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
addCrlPath(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
addCrlValue(Buffer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
addCrlValue(Buffer) - Method in class io.vertx.ext.web.client.WebClientOptions
 
addEnabledCipherSuite(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
addEnabledCipherSuite(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
addEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
addEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
addHeader(CharSequence, CharSequence) - Method in interface io.vertx.ext.web.client.WebClientSession
Configure the client to add an HTTP header to every request.
addHeader(String, String) - Method in interface io.vertx.ext.web.client.WebClientSession
Configure the client to add an HTTP header to every request.
addHeader(CharSequence, Iterable<CharSequence>) - Method in interface io.vertx.ext.web.client.WebClientSession
Configure the client to add an HTTP header to every request.
addHeader(String, Iterable<String>) - Method in interface io.vertx.ext.web.client.WebClientSession
Configure the client to add an HTTP header to every request.
addNonProxyHost(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
addQueryParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
Add a query parameter to the request.
apply(ResponsePredicateResult) - Method in interface io.vertx.ext.web.client.predicate.ErrorConverter
Deprecated.
 
as(BodyCodec<U>) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to decode the response with the responseCodec.
authentication(Credentials) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to perform HTTP Authentication.

B

basicAuthentication(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to perform basic access authentication.
basicAuthentication(Buffer, Buffer) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to perform basic access authentication.
bearerTokenAuthentication(String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to perform bearer token authentication.
body() - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsBuffer() - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsJson(Class<R>) - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsJsonArray() - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsJsonObject() - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsString() - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyAsString(String) - Method in interface io.vertx.ext.web.client.HttpResponse
 
bodyCodec() - Method in interface io.vertx.ext.web.client.HttpRequest
 
build() - Static method in interface io.vertx.ext.web.client.spi.CacheStore
Builds a no-op cache store.
build() - Static method in interface io.vertx.ext.web.client.spi.CookieStore
Builds an in memory cookie store.

C

CacheStore - Interface in io.vertx.ext.web.client.spi
An API to store and retrieve HTTP responses.
CachingWebClient - Interface in io.vertx.ext.web.client
An asynchronous cache aware HTTP / HTTP/2 client called CachingWebClient.
CachingWebClientOptions - Class in io.vertx.ext.web.client
 
CachingWebClientOptions() - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
 
CachingWebClientOptions(boolean) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
 
CachingWebClientOptions(WebClientOptions) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
 
CachingWebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
 
CachingWebClientOptionsConverter - Class in io.vertx.ext.web.client
Converter and mapper for CachingWebClientOptions.
CachingWebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.CachingWebClientOptionsConverter
 
close() - Method in interface io.vertx.ext.web.client.WebClient
Close the client.
connectTimeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
Sets the amount of time after which, if the request is not obtained from the client within the timeout period, the response is failed with a TimeoutException.
connectTimeout() - Method in interface io.vertx.ext.web.client.HttpRequest
 
contentType(String) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a predicate validating the response has a content-type header matching the mimeType.
contentType(List<String>) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a predicate validating the response has a content-type header matching one of the mimeTypes.
CookieStore - Interface in io.vertx.ext.web.client.spi
A cookie store that manages cookies for a single user; received for different domains and valid for different paths.
cookieStore() - Method in interface io.vertx.ext.web.client.WebClientSession
Returns this client's CookieStore
copy() - Method in interface io.vertx.ext.web.client.HttpRequest
Copy this request
create(WebClient) - Static method in interface io.vertx.ext.web.client.CachingWebClient
Create a cache aware web client using the provided WebClient.
create(WebClient, CacheStore) - Static method in interface io.vertx.ext.web.client.CachingWebClient
Create a cache aware web client using the provided WebClient.
create(WebClient, CachingWebClientOptions) - Static method in interface io.vertx.ext.web.client.CachingWebClient
Create a cache aware web client using the provided WebClient.
create(WebClient, CacheStore, CachingWebClientOptions) - Static method in interface io.vertx.ext.web.client.CachingWebClient
Create a cache aware web client using the provided WebClient.
create(WebClient, OAuth2Auth) - Static method in interface io.vertx.ext.web.client.OAuth2WebClient
Create a session aware web client using the provided webClient instance.
create(WebClient, OAuth2Auth, OAuth2WebClientOptions) - Static method in interface io.vertx.ext.web.client.OAuth2WebClient
Create a session aware web client using the provided webClient instance.
create(Function<ResponsePredicateResult, Throwable>) - Static method in interface io.vertx.ext.web.client.predicate.ErrorConverter
Deprecated.
Creates a full ErrorConverter, that will passed a predicate result with the response body.
create(Function<HttpResponse<Void>, ResponsePredicateResult>) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a new ResponsePredicate.
create(Function<HttpResponse<Void>, ResponsePredicateResult>, ErrorConverter) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a new ResponsePredicate, using a custom errorConverter.
create(Vertx) - Static method in interface io.vertx.ext.web.client.WebClient
Create a web client using the provided vertx instance and default options.
create(Vertx, WebClientOptions) - Static method in interface io.vertx.ext.web.client.WebClient
Create a web client using the provided vertx instance.
create(WebClient) - Static method in interface io.vertx.ext.web.client.WebClientSession
Create a session aware web client using the provided webClient instance.
create(WebClient, CookieStore) - Static method in interface io.vertx.ext.web.client.WebClientSession
Create a session aware web client using the provided webClient instance.
createFullBody(Function<ResponsePredicateResult, Throwable>) - Static method in interface io.vertx.ext.web.client.predicate.ErrorConverter
Deprecated.
Creates a full ErrorConverter, that will passed a predicate result with the response body.

D

DEFAULT_CACHED_METHODS - Static variable in class io.vertx.ext.web.client.CachingWebClientOptions
 
DEFAULT_CACHED_STATUS_CODES - Static variable in class io.vertx.ext.web.client.CachingWebClientOptions
 
DEFAULT_CONVERTER - Static variable in interface io.vertx.ext.web.client.predicate.ErrorConverter
Deprecated.
 
DEFAULT_EXPAND_OPTIONS - Static variable in class io.vertx.ext.web.client.WebClientOptions
 
DEFAULT_FOLLOW_REDIRECTS - Static variable in class io.vertx.ext.web.client.WebClientOptions
The default value of whether the Web Client should follow redirects = true.
DEFAULT_LEEWAY - Static variable in class io.vertx.ext.web.client.OAuth2WebClientOptions
The default leeway when validating token expiration times.
DEFAULT_RENEW_TOKEN_ON_FORBIDDEN - Static variable in class io.vertx.ext.web.client.OAuth2WebClientOptions
The default value of whether to perform a single token refresh if the response status code is 401 (Forbidden).
DEFAULT_USER_AGENT - Static variable in class io.vertx.ext.web.client.WebClientOptions
The default user agent string = Vert.x-WebClient/<version>.
DEFAULT_USER_AGENT_ENABLED - Static variable in class io.vertx.ext.web.client.WebClientOptions
The default value of whether the Web Client should send a user agent header = true.
delete(CacheKey) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Delete a key from the cache.
delete(CacheKey, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Delete all variations of a key from the cache.
delete(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the default host and port.
delete(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the default host and port.
delete(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the specified host and port.
delete(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the specified host and port.
delete(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the specified host and default port.
delete(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server at the specified host and default port.
deleteAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
deleteAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response

E

ErrorConverter - Interface in io.vertx.ext.web.client.predicate
Deprecated.
errorConverter() - Method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
 
expect(Function<HttpResponse<Void>, ResponsePredicateResult>) - Method in interface io.vertx.ext.web.client.HttpRequest
Deprecated.
expect(ResponsePredicate) - Method in interface io.vertx.ext.web.client.HttpRequest
Deprecated.
expectations() - Method in interface io.vertx.ext.web.client.HttpRequest
Deprecated.

F

failure(String) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicateResult
Deprecated.
Creates a failed result.
flush() - Method in interface io.vertx.ext.web.client.spi.CacheStore
Delete all entries from the cache.
flush(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Delete all entries from the cache.
followedRedirects() - Method in interface io.vertx.ext.web.client.HttpResponse
 
followRedirects(boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
Set whether to follow request redirections
followRedirects() - Method in interface io.vertx.ext.web.client.HttpRequest
 

G

get(CacheKey) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Retrieve a cached response.
get(CacheKey, Handler<AsyncResult<CachedHttpResponse>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Retrieve a cached response.
get(Boolean, String, String) - Method in interface io.vertx.ext.web.client.spi.CookieStore
Returns and Iterable of cookies satisfying the filters passed as paraemters.
get(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the default host and port.
get(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the default host and port.
get(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the specified host and port.
get(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the specified host and port.
get(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the specified host and default port.
get(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server at the specified host and default port.
getAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
getAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
getCachedMethods() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
getCachedStatusCodes() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
getLeeway() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
Weather to allow leeway while validating if a token is considered expired.
getTemplateExpandOptions() - Method in class io.vertx.ext.web.client.WebClientOptions
 
getTrailer(String) - Method in interface io.vertx.ext.web.client.HttpResponse
Return the first trailer value with the specified name
getUser() - Method in interface io.vertx.ext.web.client.OAuth2WebClient
Get the authenticated user (if any) that is associated with this client.
getUserAgent() - Method in class io.vertx.ext.web.client.WebClientOptions
 

H

head(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the default host and port.
head(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the default host and port.
head(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the specified host and port.
head(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the specified host and port.
head(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the specified host and default port.
head(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server at the specified host and default port.
headAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
headAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
headers() - Method in interface io.vertx.ext.web.client.HttpRequest
 
host(String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to use a new host value.
host() - Method in interface io.vertx.ext.web.client.HttpRequest
 
HttpRequest<T> - Interface in io.vertx.ext.web.client
A client-side HTTP request.
HttpResponse<T> - Interface in io.vertx.ext.web.client
An HTTP response.

I

idleTimeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
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.
idleTimeout() - Method in interface io.vertx.ext.web.client.HttpRequest
 
io.vertx.ext.web.client - package io.vertx.ext.web.client
 
io.vertx.ext.web.client.predicate - package io.vertx.ext.web.client.predicate
 
io.vertx.ext.web.client.spi - package io.vertx.ext.web.client.spi
 
isFollowRedirects() - Method in class io.vertx.ext.web.client.WebClientOptions
 
isRenewTokenOnForbidden() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
Weather to refresh or not the current user token if a forbidden http status response is received.
isUserAgentEnabled() - Method in class io.vertx.ext.web.client.WebClientOptions
 
isVaryCachingEnabled() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 

J

JSON - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a predicate validating the response content-type is application/json.

L

loadUserAgent() - Static method in class io.vertx.ext.web.client.WebClientOptions
 
localStore() - Static method in interface io.vertx.ext.web.client.spi.CacheStore
Builds a cache store that uses a ConcurrentHashMap.

M

message() - Method in interface io.vertx.ext.web.client.predicate.ResponsePredicateResult
Deprecated.
The failure message.
method(HttpMethod) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to use a new method value.
method() - Method in interface io.vertx.ext.web.client.HttpRequest
 
multipartMixed(boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
Allow or disallow multipart mixed encoding when sending MultipartForm having files sharing the same file name.
multipartMixed() - Method in interface io.vertx.ext.web.client.HttpRequest
 

O

OAuth2WebClient - Interface in io.vertx.ext.web.client
An asynchronous OAuth2/OIDC aware HTTP / HTTP/2 client called WebClientOAuth2.
OAuth2WebClientOptions - Class in io.vertx.ext.web.client
 
OAuth2WebClientOptions() - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
 
OAuth2WebClientOptions(OAuth2WebClientOptions) - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
Copy constructor.
OAuth2WebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
Creates a new instance from JSON.
OAuth2WebClientOptionsConverter - Class in io.vertx.ext.web.client
Converter and mapper for OAuth2WebClientOptions.
OAuth2WebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptionsConverter
 

P

patch(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the default host and port.
patch(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the default host and port.
patch(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the specified host and port.
patch(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the specified host and port.
patch(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the specified host and default port.
patch(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server at the specified host and default port.
patchAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response
patchAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response
port(int) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to use a new port value.
port() - Method in interface io.vertx.ext.web.client.HttpRequest
 
post(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the default host and port.
post(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the default host and port.
post(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the specified host and port.
post(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the specified host and port.
post(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the specified host and default port.
post(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server at the specified host and default port.
postAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
postAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
proxy(ProxyOptions) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to set a proxy for this request.
proxy() - Method in interface io.vertx.ext.web.client.HttpRequest
 
put(Cookie) - Method in interface io.vertx.ext.web.client.spi.CookieStore
Add a cookie to this CookieStore.
put(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the default host and port.
put(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the default host and port.
put(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the specified host and port.
put(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the specified host and port.
put(String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the specified host and default port.
put(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server at the specified host and default port.
putAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
putAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
putHeader(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to set a new HTTP header.
putHeader(String, Iterable<String>) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to set a new HTTP header with multiple values.
putHeaders(MultiMap) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to add multiple HTTP headers .

Q

queryParams() - Method in interface io.vertx.ext.web.client.HttpRequest
Return the current query parameters.

R

remove(Cookie) - Method in interface io.vertx.ext.web.client.spi.CookieStore
Removes a previously added cookie.
removeCachedMethod(HttpMethod) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Remove an HTTP method that is cacheable.
removeCachedStatusCode(Integer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Remove a status code that is cacheable.
removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
removeHeader(CharSequence) - Method in interface io.vertx.ext.web.client.WebClientSession
Removes a previously added header.
removeHeader(String) - Method in interface io.vertx.ext.web.client.WebClientSession
Removes a previously added header.
request(HttpMethod, int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the specified host and port.
request(HttpMethod, int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the specified host and port.
request(HttpMethod, SocketAddress, int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, int, String, String) using the serverAddress parameter to connect to the server instead of the port and host parameters.
request(HttpMethod, SocketAddress, int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, int, String, UriTemplate) using the serverAddress parameter to connect to the server instead of the port and host parameters.
request(HttpMethod, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the specified host and default port.
request(HttpMethod, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the specified host and default port.
request(HttpMethod, SocketAddress, String, String) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, String, String) using the serverAddress parameter to connect to the server instead of the default port and host parameter.
request(HttpMethod, SocketAddress, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, String, UriTemplate) using the serverAddress parameter to connect to the server instead of the default port and host parameter.
request(HttpMethod, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the default host and port.
request(HttpMethod, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the default host and port.
request(HttpMethod, SocketAddress, String) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, String) using the serverAddress parameter to connect to the server instead of the default port and default host.
request(HttpMethod, SocketAddress, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, UriTemplate) using the serverAddress parameter to connect to the server instead of the default port and default host.
request(HttpMethod, RequestOptions) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server at the specified host and port.
request(HttpMethod, SocketAddress, RequestOptions) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.request(HttpMethod, RequestOptions) using the serverAddress parameter to connect to the server instead of the options parameter.
requestAbs(HttpMethod, String) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server using an absolute URI
requestAbs(HttpMethod, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Create an HTTP request to send to the server using an absolute URI
requestAbs(HttpMethod, SocketAddress, String) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.requestAbs(HttpMethod, String) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.
requestAbs(HttpMethod, SocketAddress, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.requestAbs(HttpMethod, UriTemplate) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.
requiresBody() - Method in interface io.vertx.ext.web.client.predicate.ErrorConverter
Deprecated.
 
response() - Method in interface io.vertx.ext.web.client.predicate.ResponsePredicateResult
Deprecated.
The HttpResponse which has been tested.
ResponsePredicate - Interface in io.vertx.ext.web.client.predicate
Deprecated.
ResponsePredicateResult - Interface in io.vertx.ext.web.client.predicate
Deprecated.

S

SC_ACCEPTED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
202 Accepted
SC_BAD_GATEWAY - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
502 Bad Gateway
SC_BAD_REQUEST - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
400 Bad Request
SC_CLIENT_ERRORS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Any 4XX client error
SC_CONFLICT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
409 Conflict
SC_CONTINUE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
100 Continue
SC_CREATED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
201 Created
SC_EARLY_HINTS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
103 Early Hints
SC_EXPECTATION_FAILED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
417 Expectation Failed
SC_FAILED_DEPENDENCY - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
424 Failed Dependency (WebDAV, RFC4918)
SC_FORBIDDEN - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
403 Forbidden
SC_FOUND - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
302 Found
SC_GATEWAY_TIMEOUT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
504 Gateway Timeout
SC_GONE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
410 Gone
SC_HTTP_VERSION_NOT_SUPPORTED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
505 HTTP Version Not Supported
SC_INFORMATIONAL_RESPONSE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Any 1XX informational response
SC_INSUFFICIENT_STORAGE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
507 Insufficient Storage (WebDAV, RFC4918)
SC_INTERNAL_SERVER_ERROR - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
500 Internal Server Error
SC_LENGTH_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
411 Length Required
SC_LOCKED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
423 Locked (WebDAV, RFC4918)
SC_METHOD_NOT_ALLOWED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
405 Method Not Allowed
SC_MISDIRECTED_REQUEST - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
421 Misdirected Request
SC_MOVED_PERMANENTLY - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
301 Moved Permanently
SC_MULTI_STATUS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
207 Multi-Status (WebDAV, RFC2518)
SC_MULTIPLE_CHOICES - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
300 Multiple Choices
SC_NETWORK_AUTHENTICATION_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
511 Network Authentication Required (RFC6585)
SC_NO_CONTENT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
204 No Content
SC_NON_AUTHORITATIVE_INFORMATION - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
203 Non-Authoritative Information (since HTTP/1.1)
SC_NOT_ACCEPTABLE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
406 Not Acceptable
SC_NOT_EXTENDED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
510 Not Extended (RFC2774)
SC_NOT_FOUND - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
404 Not Found
SC_NOT_IMPLEMENTED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
501 Not Implemented
SC_NOT_MODIFIED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
304 Not Modified
SC_OK - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
200 OK
SC_PARTIAL_CONTENT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
206 Partial Content
SC_PAYMENT_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
402 Payment Required
SC_PERMANENT_REDIRECT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
308 Permanent Redirect (RFC7538)
SC_PRECONDITION_FAILED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
412 Precondition Failed
SC_PRECONDITION_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
428 Precondition Required (RFC6585)
SC_PROCESSING - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
102 Processing (WebDAV, RFC2518)
SC_PROXY_AUTHENTICATION_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
407 Proxy Authentication Required
SC_REDIRECTION - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Any 3XX redirection
SC_REQUEST_ENTITY_TOO_LARGE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
413 Request Entity Too Large
SC_REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
431 Request Header Fields Too Large (RFC6585)
SC_REQUEST_TIMEOUT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
408 Request Timeout
SC_REQUEST_URI_TOO_LONG - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
414 Request-URI Too Long
SC_REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
416 Requested Range Not Satisfiable
SC_RESET_CONTENT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
205 Reset Content
SC_SEE_OTHER - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
303 See Other (since HTTP/1.1)
SC_SERVER_ERRORS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Any 5XX server error
SC_SERVICE_UNAVAILABLE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
503 Service Unavailable
SC_SUCCESS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Any 2XX success
SC_SWITCHING_PROTOCOLS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
101 Switching Protocols
SC_TEMPORARY_REDIRECT - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
307 Temporary Redirect (since HTTP/1.1)
SC_TOO_MANY_REQUESTS - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
429 Too Many Requests (RFC6585)
SC_UNAUTHORIZED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
401 Unauthorized
SC_UNORDERED_COLLECTION - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
425 Unordered Collection (WebDAV, RFC3648)
SC_UNPROCESSABLE_ENTITY - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
422 Unprocessable Entity (WebDAV, RFC4918)
SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
415 Unsupported Media Type
SC_UPGRADE_REQUIRED - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
426 Upgrade Required (RFC2817)
SC_USE_PROXY - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
305 Use Proxy (since HTTP/1.1)
SC_VARIANT_ALSO_NEGOTIATES - Static variable in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
506 Variant Also Negotiates (RFC2295)
send(Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Send a request, the handler will receive the response as an HttpResponse.
send() - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendBuffer(Buffer, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body buffer.
sendBuffer(Buffer) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendForm(MultiMap, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body multimap encoded as form and the content type set to application/x-www-form-urlencoded.
sendForm(MultiMap) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendForm(MultiMap, String, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body multimap encoded as form and the content type set to application/x-www-form-urlencoded.
sendForm(MultiMap, String) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendJson(Object, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body object encoded as json and the content type set to application/json.
sendJson(Object) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendJsonObject(JsonObject, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body object encoded as json and the content type set to application/json.
sendJsonObject(JsonObject) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendMultipartForm(MultipartForm, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body multimap encoded as form and the content type set to multipart/form-data.
sendMultipartForm(MultipartForm) - Method in interface io.vertx.ext.web.client.HttpRequest
 
sendStream(ReadStream<Buffer>, Handler<AsyncResult<HttpResponse<T>>>) - Method in interface io.vertx.ext.web.client.HttpRequest
Like HttpRequest.send(Handler) but with an HTTP request body stream.
sendStream(ReadStream<Buffer>) - Method in interface io.vertx.ext.web.client.HttpRequest
 
set(CacheKey, CachedHttpResponse) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Add a response in the cache with the given key.
set(CacheKey, CachedHttpResponse, Handler<AsyncResult<CachedHttpResponse>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
Add a response in the cache with the given key.
setAlpnVersions(List<HttpVersion>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setAlpnVersions(List<HttpVersion>) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setCachedMethods(Set<HttpMethod>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Configure the HTTP methods that can be cached.
setCachedStatusCodes(Set<Integer>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Configure the status codes that can be cached.
setConnectTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setConnectTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setDecoderInitialBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setDecoderInitialBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setDecompressionSupported(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setDecompressionSupported(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setDefaultHost(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setDefaultHost(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setDefaultPort(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setDefaultPort(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setEnabledSecureTransportProtocols(Set<String>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setEnabledSecureTransportProtocols(Set<String>) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setEnableVaryCaching(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Configure the client cache behavior for Vary responses.
setFollowRedirects(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setFollowRedirects(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
Configure the default behavior of the client to follow HTTP 30x redirections.
setForceSni(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setForceSni(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setHttp2ClearTextUpgrade(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setHttp2ClearTextUpgrade(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setHttp2ConnectionWindowSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setHttp2ConnectionWindowSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setHttp2KeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setHttp2KeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setHttp2MaxPoolSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setHttp2MaxPoolSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setHttp2MultiplexingLimit(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setHttp2MultiplexingLimit(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setIdleTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setIdleTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setIdleTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setInitialSettings(Http2Settings) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setInitialSettings(Http2Settings) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setJdkSslEngineOptions(JdkSSLEngineOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setJdkSslEngineOptions(JdkSSLEngineOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setKeepAlive(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setKeepAlive(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setKeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setKeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setKeyCertOptions(KeyCertOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setKeyCertOptions(KeyCertOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setKeyStoreOptions(JksOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setKeyStoreOptions(JksOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setLeeway(int) - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
Set a default leeway in seconds to be considered while validating tokens for expiration.
setLocalAddress(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setLocalAddress(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setLogActivity(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setLogActivity(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxChunkSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxChunkSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxHeaderSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxHeaderSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxInitialLineLength(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxInitialLineLength(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxPoolSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxPoolSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxRedirects(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxRedirects(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxWaitQueueSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxWaitQueueSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxWebSocketFrameSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxWebSocketFrameSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxWebSocketMessageSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMaxWebSocketMessageSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMaxWebSockets(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setMetricsName(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setMetricsName(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setName(String) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setNonProxyHosts(List<String>) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setOpenSslEngineOptions(OpenSSLEngineOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setOpenSslEngineOptions(OpenSSLEngineOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPemKeyCertOptions(PemKeyCertOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPemKeyCertOptions(PemKeyCertOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPemTrustOptions(PemTrustOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPemTrustOptions(PemTrustOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPfxKeyCertOptions(PfxOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPfxKeyCertOptions(PfxOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPfxTrustOptions(PfxOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPfxTrustOptions(PfxOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPipelining(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPipelining(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPipeliningLimit(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPipeliningLimit(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPoolCleanerPeriod(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setPoolCleanerPeriod(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setPoolEventLoopSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setProtocolVersion(HttpVersion) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setProtocolVersion(HttpVersion) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setProxyOptions(ProxyOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setProxyOptions(ProxyOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setQueryParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
Set a query parameter to the request.
setReadIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setReceiveBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setReceiveBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setRenewTokenOnForbidden(boolean) - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
Set a default behavior on how to handle the first forbidden response.
setReuseAddress(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setReuseAddress(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setReusePort(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setReusePort(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSendBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSendBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSendUnmaskedFrames(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSendUnmaskedFrames(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setShared(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSoLinger(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSoLinger(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSsl(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSsl(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSslEngineOptions(SSLEngineOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSslEngineOptions(SSLEngineOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSslHandshakeTimeout(long) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSslHandshakeTimeout(long) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setSslHandshakeTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setSslHandshakeTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTcpCork(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTcpCork(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTcpFastOpen(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTcpFastOpen(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTcpKeepAlive(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTcpKeepAlive(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTcpNoDelay(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTcpNoDelay(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTcpQuickAck(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTcpQuickAck(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTemplateExpandOptions(ExpandOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTemplateParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
Set a request URI template string parameter to the request, expanded when the request URI is a UriTemplate.
setTemplateParam(String, List<String>) - Method in interface io.vertx.ext.web.client.HttpRequest
Set a request URI template list parameter to the request, expanded when the request URI is a UriTemplate.
setTemplateParam(String, Map<String, String>) - Method in interface io.vertx.ext.web.client.HttpRequest
Set a request URI template map parameter to the request, expanded when the request URI is a UriTemplate.
setTracingPolicy(TracingPolicy) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTrafficClass(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTrafficClass(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTrustAll(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTrustAll(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTrustOptions(TrustOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTrustOptions(TrustOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTrustStoreOptions(JksOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTrustStoreOptions(JksOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTryUseCompression(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Deprecated.
setTryUseCompression(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
Deprecated.
setTryUsePerFrameWebSocketCompression(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTryUsePerFrameWebSocketCompression(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setTryUsePerMessageWebSocketCompression(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setTryUsePerMessageWebSocketCompression(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setUseAlpn(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setUseAlpn(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setUserAgent(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setUserAgent(String) - Method in class io.vertx.ext.web.client.WebClientOptions
Sets the Web Client user agent header.
setUserAgentEnabled(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setUserAgentEnabled(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
Sets whether the Web Client should send a user agent header.
setVerifyHost(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setVerifyHost(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setWebSocketClosingTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setWebSocketCompressionAllowClientNoContext(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setWebSocketCompressionAllowClientNoContext(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setWebSocketCompressionLevel(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setWebSocketCompressionLevel(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setWebSocketCompressionRequestServerNoContext(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
 
setWebSocketCompressionRequestServerNoContext(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
 
setWriteIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
 
sharedDataStore(Vertx) - Static method in interface io.vertx.ext.web.client.spi.CacheStore
Builds a cache store that uses an AsyncMap from SharedData.
ssl(Boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request whether to use SSL.
ssl() - Method in interface io.vertx.ext.web.client.HttpRequest
 
status(int) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a predicate asserting that the status response code is equal to statusCode.
status(int, int) - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicate
Deprecated.
Creates a predicate asserting that the status response code is in the [min,max[ range.
succeeded() - Method in interface io.vertx.ext.web.client.predicate.ResponsePredicateResult
Deprecated.
Whether the result is a success or failure.
success() - Static method in interface io.vertx.ext.web.client.predicate.ResponsePredicateResult
Deprecated.
 

T

templateParams() - Method in interface io.vertx.ext.web.client.HttpRequest
Return the current request URI template parameters.
timeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
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.
timeout() - Method in interface io.vertx.ext.web.client.HttpRequest
 
toJson() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
Convert to JSON
toJson() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
Convert to JSON
toJson() - Method in class io.vertx.ext.web.client.WebClientOptions
Convert to JSON
traceOperation(String) - Method in interface io.vertx.ext.web.client.HttpRequest
Trace operation name override.
traceOperation() - Method in interface io.vertx.ext.web.client.HttpRequest
 
trailers() - Method in interface io.vertx.ext.web.client.HttpResponse
 

U

updateSSLOptions(SSLOptions) - Method in interface io.vertx.ext.web.client.WebClient
Update the client with new SSL options, the update happens if the options object is valid and different from the existing options object.
updateSSLOptions(SSLOptions, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.updateSSLOptions(SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
updateSSLOptions(SSLOptions, boolean) - Method in interface io.vertx.ext.web.client.WebClient
Update the client with new SSL options, the update happens if the options object is valid and different from the existing options object.
updateSSLOptions(SSLOptions, boolean, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.web.client.WebClient
Like WebClient.updateSSLOptions(SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
uri(String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to use a new request URI value.
uri() - Method in interface io.vertx.ext.web.client.HttpRequest
 

V

virtualHost(String) - Method in interface io.vertx.ext.web.client.HttpRequest
Configure the request to use a virtual host value.
virtualHost() - Method in interface io.vertx.ext.web.client.HttpRequest
 

W

WebClient - Interface in io.vertx.ext.web.client
An asynchronous HTTP / HTTP/2 client called WebClient.
WebClientOptions - Class in io.vertx.ext.web.client
 
WebClientOptions() - Constructor for class io.vertx.ext.web.client.WebClientOptions
 
WebClientOptions(WebClientOptions) - Constructor for class io.vertx.ext.web.client.WebClientOptions
Copy constructor.
WebClientOptions(HttpClientOptions) - Constructor for class io.vertx.ext.web.client.WebClientOptions
Copy constructor using HttpClientOptions.
WebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.WebClientOptions
Creates a new instance from JSON.
WebClientOptionsConverter - Class in io.vertx.ext.web.client
Converter and mapper for WebClientOptions.
WebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.WebClientOptionsConverter
 
WebClientSession - Interface in io.vertx.ext.web.client
An asynchronous sessions aware HTTP / HTTP/2 client called WebClientSession.
withCredentials(Credentials) - Method in interface io.vertx.ext.web.client.OAuth2WebClient
Mark that request should be dispatched with authentication obtained from passed OAuth2Auth provider
wrap(HttpClient) - Static method in interface io.vertx.ext.web.client.WebClient
Wrap an httpClient with a web client and default options.
wrap(HttpClient, WebClientOptions) - Static method in interface io.vertx.ext.web.client.WebClient
Wrap an httpClient with a web client and default options.
A B C D E F G H I J L M O P Q R S T U V W 
Skip navigation links

Copyright © 2025 Eclipse. All rights reserved.