Interface UpdatePipeSourceKinesisStreamParameters.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,
,UpdatePipeSourceKinesisStreamParameters> SdkBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,
,UpdatePipeSourceKinesisStreamParameters> SdkPojo
- Enclosing class:
UpdatePipeSourceKinesisStreamParameters
-
Method Summary
Modifier and TypeMethodDescriptionThe maximum number of records to include in each batch.deadLetterConfig
(Consumer<DeadLetterConfig.Builder> deadLetterConfig) Define the target queue to send dead-letter queue events to.deadLetterConfig
(DeadLetterConfig deadLetterConfig) Define the target queue to send dead-letter queue events to.maximumBatchingWindowInSeconds
(Integer maximumBatchingWindowInSeconds) The maximum length of a time to wait for events.maximumRecordAgeInSeconds
(Integer maximumRecordAgeInSeconds) Discard records older than the specified age.maximumRetryAttempts
(Integer maximumRetryAttempts) Discard records after the specified number of retries.onPartialBatchItemFailure
(String onPartialBatchItemFailure) Define how to handle item process failures.onPartialBatchItemFailure
(OnPartialBatchItemFailureStreams onPartialBatchItemFailure) Define how to handle item process failures.parallelizationFactor
(Integer parallelizationFactor) The number of batches to process concurrently from each shard.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
-
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
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 UpdatePipeSourceKinesisStreamParameters.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 theDeadLetterConfig.Builder
avoiding the need to create one manually viaDeadLetterConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todeadLetterConfig(DeadLetterConfig)
.- Parameters:
deadLetterConfig
- a consumer that will call methods onDeadLetterConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
onPartialBatchItemFailure
UpdatePipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(String onPartialBatchItemFailure) 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
- 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:
-
onPartialBatchItemFailure
UpdatePipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure) 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
- 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:
-
maximumBatchingWindowInSeconds
UpdatePipeSourceKinesisStreamParameters.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
UpdatePipeSourceKinesisStreamParameters.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) 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
- 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
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
- 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.
-
parallelizationFactor
UpdatePipeSourceKinesisStreamParameters.Builder parallelizationFactor(Integer parallelizationFactor) The number of batches to process concurrently from each shard. The default value is 1.
- Parameters:
parallelizationFactor
- 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.
-