Package io.quarkus.amazon.common.runtime
Interface AsyncHttpClientConfig
public interface AsyncHttpClientConfig
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfacestatic interfacestatic interfacestatic interfacestatic enumAn enumeration of SSL/TLS protocol providers. -
Method Summary
Modifier and TypeMethodDescriptionadvanced()Async client advanced options@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) DurationThe amount of time to wait when acquiring a connection from the pool before giving up and timing out.@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) DurationThe maximum amount of time that a connection should be allowed to remain open while idle.@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) DurationThe amount of time to wait when initially establishing a connection before giving up and timing out.The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.Netty event loop configuration overridehttp2()HTTP/2 specific configurationintThe maximum number of allowed concurrent requests.intThe maximum number of pending acquires allowed.software.amazon.awssdk.http.Protocolprotocol()The HTTP protocol to use.proxy()HTTP proxy configuration@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) DurationThe amount of time to wait for a read on a socket before an exception is thrown.The SSL Provider to be used in the Netty client.Configure whether to enable or disable TCP KeepAlive.TLS Key Managers provider configurationTLS Trust Managers provider configurationbooleanWhether the idle connections in the connection pool should be closed.@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) DurationThe amount of time to wait for a write on a socket before an exception is thrown.
-
Method Details
-
maxConcurrency
@WithDefault("50") int maxConcurrency()The maximum number of allowed concurrent requests.For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection.
-
maxPendingConnectionAcquires
@WithDefault("10000") int maxPendingConnectionAcquires()The maximum number of pending acquires allowed.Once this exceeds, acquire tries will be failed.
-
readTimeout
@WithDefault("30S") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration readTimeout()The amount of time to wait for a read on a socket before an exception is thrown.Specify `0` to disable.
-
writeTimeout
@WithDefault("30S") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration writeTimeout()The amount of time to wait for a write on a socket before an exception is thrown.Specify `0` to disable.
-
connectionTimeout
@WithDefault("10S") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration connectionTimeout()The amount of time to wait when initially establishing a connection before giving up and timing out. -
connectionAcquisitionTimeout
@WithDefault("2S") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration connectionAcquisitionTimeout()The amount of time to wait when acquiring a connection from the pool before giving up and timing out. -
connectionTimeToLive
@WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Optional<Duration> connectionTimeToLive()The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. -
connectionMaxIdleTime
@WithDefault("5S") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration connectionMaxIdleTime()The maximum amount of time that a connection should be allowed to remain open while idle.Currently has no effect if `quarkus.<amazon-service>.async-client.use-idle-connection-reaper` is false.
-
useIdleConnectionReaper
@WithDefault("true") boolean useIdleConnectionReaper()Whether the idle connections in the connection pool should be closed.When enabled, connections left idling for longer than `quarkus.<amazon-service>.async-client.connection-max-idle-time` will be closed. This will not close connections currently in use.
-
tcpKeepAlive
Configure whether to enable or disable TCP KeepAlive. -
protocol
@WithDefault("http1-1") software.amazon.awssdk.http.Protocol protocol()The HTTP protocol to use. -
sslProvider
Optional<AsyncHttpClientConfig.SslProviderType> sslProvider()The SSL Provider to be used in the Netty client.Default is `OPENSSL` if available, `JDK` otherwise.
-
http2
HTTP/2 specific configuration -
proxy
HTTP proxy configuration -
tlsKeyManagersProvider
TlsKeyManagersProviderConfig tlsKeyManagersProvider()TLS Key Managers provider configuration -
tlsTrustManagersProvider
TlsTrustManagersProviderConfig tlsTrustManagersProvider()TLS Trust Managers provider configuration -
eventLoop
AsyncHttpClientConfig.SdkEventLoopGroupConfig eventLoop()Netty event loop configuration override -
advanced
AsyncHttpClientConfig.Advanced advanced()Async client advanced options
-