Index

A B C D E F G H I K L M N O P Q R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractRestClientConfigBuilder - Class in io.quarkus.restclient.config
Registers and force load REST Client configuration.
AbstractRestClientConfigBuilder() - Constructor for class io.quarkus.restclient.config.AbstractRestClientConfigBuilder
 
AbstractRestClientConfigBuilder(boolean) - Constructor for class io.quarkus.restclient.config.AbstractRestClientConfigBuilder
 
alpn() - Method in interface io.quarkus.restclient.config.RestClientsConfig
If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server.
alpn() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server.

B

bodyLimit() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientLoggingConfig
How many characters of the body should be logged.

C

captureStacktrace() - Method in interface io.quarkus.restclient.config.RestClientsConfig
If true, the stacktrace of the invocation of the REST Client method is captured.
captureStacktrace() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
If true, the stacktrace of the invocation of the REST Client method is captured.
clients() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig
Configurations of REST client instances.
clients() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Configurations of REST client instances.
configBuilder(SmallRyeConfigBuilder) - Method in class io.quarkus.restclient.config.AbstractRestClientConfigBuilder
 
connectionPoolSize() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The size of the connection pool for this client.
connectionPoolSize() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The size of the connection pool for this client.
connectionTTL() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The time in ms for which a connection remains unused in the connection pool before being evicted and closed.
connectionTTL() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The time in ms for which a connection remains unused in the connection pool before being evicted and closed.
connectTimeout() - Method in interface io.quarkus.restclient.config.RestClientsConfig
A timeout in milliseconds that REST clients should wait to connect to the remote endpoint.
connectTimeout() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Timeout specified in milliseconds to wait to connect to the remote endpoint.
Constants - Class in io.quarkus.restclient.config
 

D

disableContextualErrorMessages() - Method in interface io.quarkus.restclient.config.RestClientsConfig
If true, the REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.
disableDefaultMapper() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
If set to true, then this REST Client will not the default exception mapper which always throws an exception if HTTP response code >= 400.

E

enableCompression() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Supports receiving compressed messages using GZIP.
enableCompression() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Supports receiving compressed messages using GZIP.
enableLocalProxy() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig.RestClientBuildConfig
If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy server (that is managed by Quarkus).

F

followRedirects() - Method in interface io.quarkus.restclient.config.RestClientsConfig
A boolean value used to determine whether the client should follow HTTP redirect responses.
followRedirects() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
A boolean value used to determine whether the client should follow HTTP redirect responses.

G

get() - Method in class io.quarkus.restclient.config.RestClientsConfig.RestClientKeysProvider
 
get(List<RegisteredRestClient>) - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig
Provides a new RestClientsBuildTimeConfig with the discovered registered REST Clients configuration only.
getClient(Class<?>) - Method in interface io.quarkus.restclient.config.RestClientsConfig
 
getConfig(List<RegisteredRestClient>) - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig
 
getConfigKey() - Method in class io.quarkus.restclient.config.RegisteredRestClient
 
getFullName() - Method in class io.quarkus.restclient.config.RegisteredRestClient
 
getInstance() - Static method in interface io.quarkus.restclient.config.RestClientBuilderFactory
 
getRestClients() - Method in class io.quarkus.restclient.config.AbstractRestClientConfigBuilder
The List of discovered REST Clients, generated during build-time.
getSimpleName() - Method in class io.quarkus.restclient.config.RegisteredRestClient
 
GLOBAL_REST_SCOPE_FORMAT - Static variable in class io.quarkus.restclient.config.Constants
 

H

headers() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The HTTP headers that should be applied to all requests of the rest client.
headers() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The HTTP headers that should be applied to all requests of the rest client.
hostnameVerifier() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The class name of the host name verifier.
hostnameVerifier() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The class name of the host name verifier.
http2() - Method in interface io.quarkus.restclient.config.RestClientsConfig
If this is true then HTTP/2 will be enabled.
http2() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
If this is true then HTTP/2 will be enabled.

I

io.quarkus.restclient.config - package io.quarkus.restclient.config
 
isConfigKeyComposed() - Method in class io.quarkus.restclient.config.RegisteredRestClient
 
isConfigKeyEqualsNames() - Method in class io.quarkus.restclient.config.RegisteredRestClient
 

K

keepAliveEnabled() - Method in interface io.quarkus.restclient.config.RestClientsConfig
If set to false disables the keep alive completely.
keepAliveEnabled() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
If set to false disables the keep alive completely.
KEYS - Static variable in class io.quarkus.restclient.config.RestClientsConfig.RestClientKeysProvider
 
keyStore() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The key store location.
keyStore() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The key store location.
keyStorePassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The key store password.
keyStorePassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The key store password.
keyStoreType() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The type of the key store.
keyStoreType() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The type of the key store.

L

localProxyProvider() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig.RestClientBuildConfig
This setting is used to select which proxy provider to use if there are multiple ones.
logging() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Logging configuration.
logging() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Logging configuration.

M

maxChunkSize() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Configures two different things: The max HTTP chunk size The size of the chunk to be read when an InputStream is being used as an input
maxChunkSize() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Configures two different things: The max HTTP chunk size The size of the chunk to be read when an InputStream is being read and sent to the server
maxChunkSize() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientMultipartConfig
Deprecated.
Use quarkus.rest-client.max-chunk-size instead
maxRedirects() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The maximum number of redirection a request can follow.
maxRedirects() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The maximum number of redirection a request can follow.
MP_REST - Static variable in class io.quarkus.restclient.config.Constants
 
MP_REST_SCOPE_FORMAT - Static variable in class io.quarkus.restclient.config.Constants
 
multipart() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Multipart configuration.
multipart() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Multipart configuration.
multipartPostEncoderMode() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Mode in which the form data are encoded.
multipartPostEncoderMode() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Mode in which the form data are encoded.

N

name() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Set the HTTP client name, used when the client is shared, otherwise ignored.
newBuilder(Class<?>) - Method in interface io.quarkus.restclient.config.RestClientBuilderFactory
 
newBuilder(Class<?>, RestClientsConfig) - Method in interface io.quarkus.restclient.config.RestClientBuilderFactory
 
nonProxyHosts() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings.
nonProxyHosts() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Hosts to access without proxy

O

overrideUri() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url.

P

providers() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Fully-qualified provider classnames to include in the client.
providers() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities.
proxyAddress() - Method in interface io.quarkus.restclient.config.RestClientsConfig
A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use.
proxyAddress() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use.
proxyPassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings.
proxyPassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Proxy password.
proxyUser() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Proxy username, equivalent to the http.proxy or https.proxy JVM settings.
proxyUser() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Proxy username.

Q

QUARKUS_CONFIG_PREFIX - Static variable in class io.quarkus.restclient.config.Constants
 
QUARKUS_REST_SCOPE_FORMAT - Static variable in class io.quarkus.restclient.config.Constants
 
queryParamStyle() - Method in interface io.quarkus.restclient.config.RestClientsConfig
An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED", or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.
queryParamStyle() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED", or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.

R

readTimeout() - Method in interface io.quarkus.restclient.config.RestClientsConfig
A timeout in milliseconds that REST clients should wait for a response from the remote endpoint.
readTimeout() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Timeout specified in milliseconds to wait for a response from the remote endpoint.
RegisteredRestClient - Class in io.quarkus.restclient.config
 
RegisteredRestClient(Class<?>, String) - Constructor for class io.quarkus.restclient.config.RegisteredRestClient
 
RegisteredRestClient(String, String) - Constructor for class io.quarkus.restclient.config.RegisteredRestClient
 
RegisteredRestClient(String, String, String) - Constructor for class io.quarkus.restclient.config.RegisteredRestClient
 
removesTrailingSlash() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig
If true, the extension will automatically remove the trailing slash in the paths if any.
removesTrailingSlash() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig.RestClientBuildConfig
If true, the extension will automatically remove the trailing slash in the paths if any.
RestClientBuilderFactory - Interface in io.quarkus.restclient.config
Factory which creates MicroProfile RestClientBuilder instance configured according to current Quarkus application configuration.
RestClientKeysProvider() - Constructor for class io.quarkus.restclient.config.RestClientsConfig.RestClientKeysProvider
 
RestClientsBuildTimeConfig - Interface in io.quarkus.restclient.config
 
RestClientsBuildTimeConfig.RestClientBuildConfig - Interface in io.quarkus.restclient.config
 
RestClientsConfig - Interface in io.quarkus.restclient.config
 
RestClientsConfig.RestClientConfig - Interface in io.quarkus.restclient.config
 
RestClientsConfig.RestClientKeysProvider - Class in io.quarkus.restclient.config
 
RestClientsConfig.RestClientLoggingConfig - Interface in io.quarkus.restclient.config
 
RestClientsConfig.RestClientMultipartConfig - Interface in io.quarkus.restclient.config
 

S

scope() - Method in interface io.quarkus.restclient.config.RestClientsBuildTimeConfig.RestClientBuildConfig
The CDI scope to use for injection.
scope() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientLoggingConfig
Scope of logging for the client.
scope() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The CDI scope to use for injections of REST client instances.
shared() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Set to true to share the HTTP client between REST clients.

T

tlsConfigurationName() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The name of the TLS configuration to use.
tlsConfigurationName() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The name of the TLS configuration to use.
trustStore() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The trust store location.
trustStore() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The trust store location.
trustStorePassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The trust store password.
trustStorePassword() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The trust store password.
trustStoreType() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The type of the trust store.
trustStoreType() - Method in interface io.quarkus.restclient.config.RestClientsConfig
The type of the trust store.

U

uri() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The base URI to use for this service.
uriReload() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
 
uriValue() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Duplicate mapping of RestClientsConfig.RestClientConfig.uri() to keep a reference of the name used to retrieve the uri.
url() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
The base URL to use for this service.
urlReload() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
 
urlValue() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Duplicate mapping of RestClientsConfig.RestClientConfig.url() to keep a reference of the name used to retrieve the url.
userAgent() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Configure the HTTP user-agent header to use.
userAgent() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Default configuration for the HTTP user-agent header to use in all REST clients.

V

verifyHost() - Method in interface io.quarkus.restclient.config.RestClientsConfig.RestClientConfig
Set whether hostname verification is enabled.
verifyHost() - Method in interface io.quarkus.restclient.config.RestClientsConfig
Set whether hostname verification is enabled.
A B C D E F G H I K L M N O P Q R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values