software.amazon.awssdk.http.nio.netty

Interface NettySdkHttpClientFactory.Builder

All Superinterfaces:

CopyableBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>, SdkBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>

Enclosing class:

NettySdkHttpClientFactory

public static interface NettySdkHttpClientFactory.Builder
extends CopyableBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>

Builder interface for NettySdkHttpClientFactory.

See Also:

NettySdkHttpClientFactory.builder()

Method Summary

Modifier and Type	Method and Description
NettySdkHttpClientFactory.Builder	connectionAcquisitionTimeout(Duration timeout) The amount of time to wait when acquiring a connection from the pool before giving up and timing out.
NettySdkHttpClientFactory.Builder	connectionTimeout(Duration timeout) The amount of time to wait when initially establishing a connection before giving up and timing out.
default NettySdkHttpClientFactory.Builder	eventLoopGroupConfiguration(Consumer<EventLoopGroupConfiguration.Builder> eventLoopGroupConfiguration) Configuration for the Netty EventLoopGroup which multiplexes IO events.
NettySdkHttpClientFactory.Builder	eventLoopGroupConfiguration(EventLoopGroupConfiguration eventLoopGroupConfiguration) Configuration for the Netty EventLoopGroup which multiplexes IO events.
NettySdkHttpClientFactory.Builder	maxConnectionsPerEndpoint(Integer maxConnectionsPerEndpoint) Max allowed connections per endpoint allowed in the connection pool.
NettySdkHttpClientFactory.Builder	maxPendingAcquires(Integer maxPendingAcquires) The maximum number of pending acquires allowed.
NettySdkHttpClientFactory.Builder	readTimeout(Duration timeout) The amount of time to wait for a read on a socket before an exception is thrown.
NettySdkHttpClientFactory.Builder	trustAllCertificates(Boolean trustAllCertificates) Forces the HTTP client to trust all certificates, even invalid or self signed certificates.
NettySdkHttpClientFactory.Builder	writeTimeout(Duration timeout) The amount of time to wait for a write on a socket before an exception is thrown.

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

copy

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

apply, build

Method Detail

maxConnectionsPerEndpoint

NettySdkHttpClientFactory.Builder maxConnectionsPerEndpoint(Integer maxConnectionsPerEndpoint)

Max allowed connections per endpoint allowed in the connection pool.

Parameters:

maxConnectionsPerEndpoint - New value for max connections per endpoint.

Returns:

This builder for method chaining.

maxPendingAcquires

NettySdkHttpClientFactory.Builder maxPendingAcquires(Integer maxPendingAcquires)

The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed.

Parameters:

maxPendingAcquires - Max number of pending acquires

Returns:

This builder for method chaining.

readTimeout

NettySdkHttpClientFactory.Builder readTimeout(Duration timeout)

The amount of time to wait for a read on a socket before an exception is thrown.
note: minimum supported granularity is seconds, if Duration cannot be converted to a whole second an exception will be thrown

Parameters:

timeout - timeout duration

Returns:

this builder for method chaining.

writeTimeout

NettySdkHttpClientFactory.Builder writeTimeout(Duration timeout)

The amount of time to wait for a write on a socket before an exception is thrown.
note: minimum supported granularity is seconds, if Duration cannot be converted to a whole second an exception will be thrown

Parameters:

timeout - timeout duration

Returns:

this builder for method chaining.

connectionTimeout

NettySdkHttpClientFactory.Builder connectionTimeout(Duration timeout)

The amount of time to wait when initially establishing a connection before giving up and timing out. Defaults to NettySdkHttpClientFactory.connectionTimeout() if not set.

Parameters:

timeout - the timeout duration

Returns:

this builder for method chaining.

connectionAcquisitionTimeout

NettySdkHttpClientFactory.Builder connectionAcquisitionTimeout(Duration timeout)

The amount of time to wait when acquiring a connection from the pool before giving up and timing out.

Parameters:

timeout - the timeout duration

Returns:

this builder for method chaining.

trustAllCertificates

NettySdkHttpClientFactory.Builder trustAllCertificates(Boolean trustAllCertificates)

Forces the HTTP client to trust all certificates, even invalid or self signed certificates. This should only ever be used for testing purposes.

Parameters:

trustAllCertificates - Whether to trust all certificates. The default is false and only valid certificates whose trust can be verified via the trust store will be trusted.

Returns:

This builder for method chaining.

eventLoopGroupConfiguration

NettySdkHttpClientFactory.Builder eventLoopGroupConfiguration(EventLoopGroupConfiguration eventLoopGroupConfiguration)

Configuration for the Netty EventLoopGroup which multiplexes IO events.

If none is provided then a default EventLoopGroup will be used. This default EventLoopGroup will be shared across all HTTP client instances and will be automatically shutdown by the SDK when no references to it remain.

Parameters:

eventLoopGroupConfiguration - New configuration object.

Returns:

This builder for method chaining.

eventLoopGroupConfiguration

default NettySdkHttpClientFactory.Builder eventLoopGroupConfiguration(Consumer<EventLoopGroupConfiguration.Builder> eventLoopGroupConfiguration)

Configuration for the Netty EventLoopGroup which multiplexes IO events.

Parameters:

eventLoopGroupConfiguration - consumer that allows a EventLoopGroupConfiguration.Builder to be mutated.

Returns:

This builder for method chaining.

See Also:

eventLoopGroupConfiguration(EventLoopGroupConfiguration)