software.amazon.awssdk.services.pipes.model

Interface PipeSourceDynamoDBStreamParameters.Builder

All Superinterfaces:

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

Enclosing class:

PipeSourceDynamoDBStreamParameters

public static interface PipeSourceDynamoDBStreamParameters.Builder
extends SdkPojo, CopyableBuilder<PipeSourceDynamoDBStreamParameters.Builder,PipeSourceDynamoDBStreamParameters>

Method Summary

Modifier and Type	Method and Description
PipeSourceDynamoDBStreamParameters.Builder	batchSize(Integer batchSize) The maximum number of records to include in each batch.
default PipeSourceDynamoDBStreamParameters.Builder	deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig) Define the target queue to send dead-letter queue events to.
PipeSourceDynamoDBStreamParameters.Builder	deadLetterConfig(DeadLetterConfig deadLetterConfig) Define the target queue to send dead-letter queue events to.
PipeSourceDynamoDBStreamParameters.Builder	maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) The maximum length of a time to wait for events.
PipeSourceDynamoDBStreamParameters.Builder	maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Streams only) Discard records older than the specified age.
PipeSourceDynamoDBStreamParameters.Builder	maximumRetryAttempts(Integer maximumRetryAttempts) (Streams only) Discard records after the specified number of retries.
PipeSourceDynamoDBStreamParameters.Builder	onPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure) (Streams only) Define how to handle item process failures.
PipeSourceDynamoDBStreamParameters.Builder	onPartialBatchItemFailure(String onPartialBatchItemFailure) (Streams only) Define how to handle item process failures.
PipeSourceDynamoDBStreamParameters.Builder	parallelizationFactor(Integer parallelizationFactor) (Streams only) The number of batches to process concurrently from each shard.
PipeSourceDynamoDBStreamParameters.Builder	startingPosition(DynamoDBStreamStartPosition startingPosition) (Streams only) The position in a stream from which to start reading.
PipeSourceDynamoDBStreamParameters.Builder	startingPosition(String startingPosition) (Streams only) The position in a stream from which to start reading.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

batchSize

PipeSourceDynamoDBStreamParameters.Builder batchSize(Integer batchSize)

The maximum number of records to include in each batch.

Parameters:

batchSize - The maximum number of records to include in each batch.

Returns:

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

deadLetterConfig

PipeSourceDynamoDBStreamParameters.Builder deadLetterConfig(DeadLetterConfig deadLetterConfig)

Define the target queue to send dead-letter queue events to.

Parameters:

deadLetterConfig - Define the target queue to send dead-letter queue events to.

Returns:

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

deadLetterConfig

default PipeSourceDynamoDBStreamParameters.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)

Define the target queue to send dead-letter queue events to.

This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).

Parameters:

deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder

Returns:

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

See Also:

deadLetterConfig(DeadLetterConfig)

maximumBatchingWindowInSeconds

PipeSourceDynamoDBStreamParameters.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

The maximum length of a time to wait for events.

Parameters:

maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

Returns:

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

maximumRecordAgeInSeconds

PipeSourceDynamoDBStreamParameters.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

Parameters:

maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

Returns:

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

maximumRetryAttempts

PipeSourceDynamoDBStreamParameters.Builder maximumRetryAttempts(Integer maximumRetryAttempts)

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

Parameters:

maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

Returns:

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

onPartialBatchItemFailure

PipeSourceDynamoDBStreamParameters.Builder onPartialBatchItemFailure(String onPartialBatchItemFailure)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

Parameters:

onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

Returns:

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

See Also:

OnPartialBatchItemFailureStreams, OnPartialBatchItemFailureStreams

onPartialBatchItemFailure

PipeSourceDynamoDBStreamParameters.Builder onPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

Parameters:

onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

Returns:

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

See Also:

OnPartialBatchItemFailureStreams, OnPartialBatchItemFailureStreams

parallelizationFactor

PipeSourceDynamoDBStreamParameters.Builder parallelizationFactor(Integer parallelizationFactor)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Parameters:

parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Returns:

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

startingPosition

PipeSourceDynamoDBStreamParameters.Builder startingPosition(String startingPosition)

(Streams only) The position in a stream from which to start reading.

Parameters:

startingPosition - (Streams only) The position in a stream from which to start reading.

Returns:

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

See Also:

DynamoDBStreamStartPosition, DynamoDBStreamStartPosition

startingPosition

PipeSourceDynamoDBStreamParameters.Builder startingPosition(DynamoDBStreamStartPosition startingPosition)

(Streams only) The position in a stream from which to start reading.

Parameters:

startingPosition - (Streams only) The position in a stream from which to start reading.

Returns:

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

See Also:

DynamoDBStreamStartPosition, DynamoDBStreamStartPosition