com.ibm.cos.v2.http.crt

Interface ConnectionHealthConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConnectionHealthConfiguration.Builder,ConnectionHealthConfiguration>, CrtConnectionHealthConfiguration.Builder, SdkBuilder<ConnectionHealthConfiguration.Builder,ConnectionHealthConfiguration>

Enclosing class:

ConnectionHealthConfiguration

public static interface ConnectionHealthConfiguration.Builder
extends CrtConnectionHealthConfiguration.Builder, CopyableBuilder<ConnectionHealthConfiguration.Builder,ConnectionHealthConfiguration>

A builder for ConnectionHealthConfiguration.

All implementations of this interface are mutable and not thread safe.

Method Summary

Modifier and Type	Method and Description
ConnectionHealthConfiguration	build() An immutable object that is created from the properties that have been set on the builder.
ConnectionHealthConfiguration.Builder	minimumThroughputInBps(Long minimumThroughputInBps) Sets a throughput threshold for connections.
ConnectionHealthConfiguration.Builder	minimumThroughputTimeout(Duration minimumThroughputTimeout) Sets how long a connection is allowed to be unhealthy before getting shut down.

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation

Method Detail

minimumThroughputInBps

ConnectionHealthConfiguration.Builder minimumThroughputInBps(Long minimumThroughputInBps)

Description copied from interface: CrtConnectionHealthConfiguration.Builder

Sets a throughput threshold for connections. Throughput below this value will be considered unhealthy.

Specified by:

minimumThroughputInBps in interface CrtConnectionHealthConfiguration.Builder

Parameters:

minimumThroughputInBps - minimum amount of throughput, in bytes per second, for a connection to be considered healthy.

Returns:

Builder

minimumThroughputTimeout

ConnectionHealthConfiguration.Builder minimumThroughputTimeout(Duration minimumThroughputTimeout)

Description copied from interface: CrtConnectionHealthConfiguration.Builder

Sets how long a connection is allowed to be unhealthy before getting shut down.

It only supports seconds precision

Specified by:

minimumThroughputTimeout in interface CrtConnectionHealthConfiguration.Builder

Parameters:

minimumThroughputTimeout - How long a connection is allowed to be unhealthy before getting shut down.

Returns:

Builder

build

ConnectionHealthConfiguration build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface CrtConnectionHealthConfiguration.Builder

Specified by:

build in interface SdkBuilder<ConnectionHealthConfiguration.Builder,ConnectionHealthConfiguration>

Returns:

an instance of T