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 for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	connectionHealthChecksConfiguration(Consumer<ConnectionHealthChecksConfiguration.Builder> healthChecksConfigurationBuilder) A convenience method to configure the health checks for for all connections established by this client.
AwsCrtAsyncHttpClient.Builder	connectionMaxIdleTime(Duration connectionMaxIdleTime) Configure the maximum amount of time that a connection should be allowed to remain open while idle.
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	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.

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 for all connections established by this client.

eg: you can set a throughput threshold for the 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 for all connections established by this client.

eg: you can set a throughput threshold for the 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)

Configure the maximum amount of time that a connection should be allowed to remain open while idle.