software.amazon.awssdk.http.crt

Interface AwsCrtAsyncHttpClient.Builder

All Superinterfaces:

Buildable, SdkAsyncHttpClient.Builder<AwsCrtAsyncHttpClient.Builder>, SdkBuilder<AwsCrtAsyncHttpClient.Builder,SdkAsyncHttpClient>

Enclosing class:

AwsCrtAsyncHttpClient

public static interface AwsCrtAsyncHttpClient.Builder
extends SdkAsyncHttpClient.Builder<AwsCrtAsyncHttpClient.Builder>

Builder that allows configuration of the AWS CRT HTTP implementation.

Method Summary

Modifier and Type	Method and Description
AwsCrtAsyncHttpClient.Builder	connectionHealthChecksConfiguration(ConnectionHealthChecksConfiguration healthChecksConfiguration) Configure the health checks for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	connectionHealthChecksConfiguration(Consumer<ConnectionHealthChecksConfiguration.Builder> healthChecksConfigurationBuilder) A convenience method to configure the health checks for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	connectionMaxIdleTime(Duration connectionMaxIdleTime) The amount of time to wait when initially establishing a connection before giving up and timing out.
AwsCrtAsyncHttpClient.Builder	connectionTimeout(Duration connectionTimeout) Configure connection socket timeout
AwsCrtAsyncHttpClient.Builder	maxConcurrency(int maxConcurrency) The Maximum number of allowed concurrent requests.
AwsCrtAsyncHttpClient.Builder	proxyConfiguration(Consumer<ProxyConfiguration.Builder> proxyConfigurationBuilderConsumer) Sets the http proxy configuration to use for this client.
AwsCrtAsyncHttpClient.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) Sets the http proxy configuration to use for this client.
AwsCrtAsyncHttpClient.Builder	readBufferSize(int readBufferSize) Configures the number of unread bytes that can be buffered in the client before we stop reading from the underlying TCP socket and wait for the Subscriber to read more data.
AwsCrtAsyncHttpClient.Builder	tcpKeepAliveConfiguration(Consumer<TcpKeepAliveConfiguration.Builder> tcpKeepAliveConfigurationBuilder) Configure whether to enable TCP Keep-alive and relevant configuration for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	tcpKeepAliveConfiguration(TcpKeepAliveConfiguration tcpKeepAliveConfiguration) Configure whether to enable TCP Keep-alive and relevant configuration for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	tlsCipherPreference(software.amazon.awssdk.crt.io.TlsCipherPreference tlsCipherPreference) The AWS CRT TlsCipherPreference to use for this Client

Methods inherited from interface software.amazon.awssdk.http.async.SdkAsyncHttpClient.Builder

build, buildWithDefaults

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Method Detail

maxConcurrency

AwsCrtAsyncHttpClient.Builder maxConcurrency(int maxConcurrency)

The Maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections.

Parameters:

maxConcurrency - maximum concurrency per endpoint

Returns:

The builder of the method chaining.

tlsCipherPreference

AwsCrtAsyncHttpClient.Builder tlsCipherPreference(software.amazon.awssdk.crt.io.TlsCipherPreference tlsCipherPreference)

The AWS CRT TlsCipherPreference to use for this Client

Parameters:

tlsCipherPreference - The AWS Common Runtime TlsCipherPreference

Returns:

The builder of the method chaining.

readBufferSize

AwsCrtAsyncHttpClient.Builder readBufferSize(int readBufferSize)

Configures the number of unread bytes that can be buffered in the client before we stop reading from the underlying TCP socket and wait for the Subscriber to read more data.

Parameters:

readBufferSize - The number of bytes that can be buffered

Returns:

The builder of the method chaining. TODO: This is also used for the write buffer size. Should we rename it?

proxyConfiguration

AwsCrtAsyncHttpClient.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

Sets the http proxy configuration to use for this client.

Parameters:

proxyConfiguration - The http proxy configuration to use

Returns:

The builder of the method chaining.

proxyConfiguration

AwsCrtAsyncHttpClient.Builder proxyConfiguration(Consumer<ProxyConfiguration.Builder> proxyConfigurationBuilderConsumer)

Sets the http proxy configuration to use for this client.

Parameters:

proxyConfigurationBuilderConsumer - The consumer of the proxy configuration builder object.

Returns:

the builder for method chaining.

connectionHealthChecksConfiguration

AwsCrtAsyncHttpClient.Builder connectionHealthChecksConfiguration(ConnectionHealthChecksConfiguration healthChecksConfiguration)

Configure the health checks for all connections established by this client.

eg: you can set a throughput threshold for a connection to be considered healthy. If the connection falls below this threshold for a configurable amount of time, then the connection is considered unhealthy and will be shut down.

Parameters:

healthChecksConfiguration - The health checks config to use

Returns:

The builder of the method chaining.

connectionHealthChecksConfiguration

AwsCrtAsyncHttpClient.Builder connectionHealthChecksConfiguration(Consumer<ConnectionHealthChecksConfiguration.Builder> healthChecksConfigurationBuilder)

A convenience method to configure the health checks for all connections established by this client.

eg: you can set a throughput threshold for a connection to be considered healthy. If the connection falls below this threshold for a configurable amount of time, then the connection is considered unhealthy and will be shut down.

Parameters:

healthChecksConfigurationBuilder - The health checks config builder to use

Returns:

The builder of the method chaining.

See Also:

connectionHealthChecksConfiguration(ConnectionHealthChecksConfiguration)

connectionMaxIdleTime

AwsCrtAsyncHttpClient.Builder connectionMaxIdleTime(Duration connectionMaxIdleTime)

The amount of time to wait when initially establishing a connection before giving up and timing out. The maximum possible value, in ms, is the value of Integer.MAX_VALUE, any longer duration will be reduced to the maximum possible value. If not specified, the connection timeout duration will be set to value defined in AwsCrtAsyncHttpClient.CRT_SDK_DEFAULT_CONNECTION_TIMEOUT.

connectionTimeout

AwsCrtAsyncHttpClient.Builder connectionTimeout(Duration connectionTimeout)

Configure connection socket timeout

tcpKeepAliveConfiguration

AwsCrtAsyncHttpClient.Builder tcpKeepAliveConfiguration(TcpKeepAliveConfiguration tcpKeepAliveConfiguration)

Configure whether to enable TCP Keep-alive and relevant configuration for all connections established by this client.

By default, keepAlive is disabled and this is not required. tcpKeepAlive is enabled by providing this configuration and specifying periodic keepalive packet intervals and timeouts This may be required for certain connections for longer durations than default socket timeouts

Parameters:

tcpKeepAliveConfiguration - The TCP keep-alive configuration to use

Returns:

The builder of the method chaining.

tcpKeepAliveConfiguration

AwsCrtAsyncHttpClient.Builder tcpKeepAliveConfiguration(Consumer<TcpKeepAliveConfiguration.Builder> tcpKeepAliveConfigurationBuilder)

Configure whether to enable TCP Keep-alive and relevant configuration for all connections established by this client.

By default, keepAlive is disabled and this is not required. tcpKeepAlive is enabled by providing this configuration and specifying periodic keepalive packet intervals and timeouts This may be required for certain connections for longer durations than default socket timeouts

Parameters:

tcpKeepAliveConfigurationBuilder - The TCP keep-alive configuration builder to use

Returns:

The builder of the method chaining.