Interface BatchConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchConfig.Builder,BatchConfig>, SdkBuilder<BatchConfig.Builder,BatchConfig>, SdkPojo

Enclosing class:

BatchConfig

@Mutable
@NotThreadSafe
public static interface BatchConfig.Builder
extends SdkPojo, CopyableBuilder<BatchConfig.Builder,BatchConfig>

Method Summary

Modifier and Type	Method	Description
BatchConfig.Builder	maxBatchOpenMs(Integer maxBatchOpenMs)	The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type.
BatchConfig.Builder	maxBatchSize(Integer maxBatchSize)	The maximum number of messages that are batched together in a single action execution.
BatchConfig.Builder	maxBatchSizeBytes(Integer maxBatchSizeBytes)	Maximum size of a message batch, in bytes.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

maxBatchOpenMs

BatchConfig.Builder maxBatchOpenMs(Integer maxBatchOpenMs)

The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.

Parameters:

maxBatchOpenMs - The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxBatchSize

BatchConfig.Builder maxBatchSize(Integer maxBatchSize)

The maximum number of messages that are batched together in a single action execution.

Parameters:

maxBatchSize - The maximum number of messages that are batched together in a single action execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxBatchSizeBytes

BatchConfig.Builder maxBatchSizeBytes(Integer maxBatchSizeBytes)

Maximum size of a message batch, in bytes.

Parameters:

maxBatchSizeBytes - Maximum size of a message batch, in bytes.

Returns:

Returns a reference to this object so that method calls can be chained together.