Interface UpdatePipeSourceKinesisStreamParameters.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,UpdatePipeSourceKinesisStreamParameters>,SdkBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,UpdatePipeSourceKinesisStreamParameters>,SdkPojo
- Enclosing class:
- UpdatePipeSourceKinesisStreamParameters
public static interface UpdatePipeSourceKinesisStreamParameters.Builder extends SdkPojo, CopyableBuilder<UpdatePipeSourceKinesisStreamParameters.Builder,UpdatePipeSourceKinesisStreamParameters>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UpdatePipeSourceKinesisStreamParameters.BuilderbatchSize(Integer batchSize)The maximum number of records to include in each batch.default UpdatePipeSourceKinesisStreamParameters.BuilderdeadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)Define the target queue to send dead-letter queue events to.UpdatePipeSourceKinesisStreamParameters.BuilderdeadLetterConfig(DeadLetterConfig deadLetterConfig)Define the target queue to send dead-letter queue events to.UpdatePipeSourceKinesisStreamParameters.BuildermaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)The maximum length of a time to wait for events.UpdatePipeSourceKinesisStreamParameters.BuildermaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)(Streams only) Discard records older than the specified age.UpdatePipeSourceKinesisStreamParameters.BuildermaximumRetryAttempts(Integer maximumRetryAttempts)(Streams only) Discard records after the specified number of retries.UpdatePipeSourceKinesisStreamParameters.BuilderonPartialBatchItemFailure(String onPartialBatchItemFailure)(Streams only) Define how to handle item process failures.UpdatePipeSourceKinesisStreamParameters.BuilderonPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)(Streams only) Define how to handle item process failures.UpdatePipeSourceKinesisStreamParameters.BuilderparallelizationFactor(Integer parallelizationFactor)(Streams only) 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, sdkFields
-
-
-
-
Method Detail
-
batchSize
UpdatePipeSourceKinesisStreamParameters.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
UpdatePipeSourceKinesisStreamParameters.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 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.Builderavoiding the need to create one manually viaDeadLetterConfig.builder().When the
Consumercompletes,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:
deadLetterConfig(DeadLetterConfig)
-
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)
(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
UpdatePipeSourceKinesisStreamParameters.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
UpdatePipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(String onPartialBatchItemFailure)
(Streams only) Define how to handle item process failures.
AUTOMATIC_BISECThalves 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_BISECThalves 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
UpdatePipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)
(Streams only) Define how to handle item process failures.
AUTOMATIC_BISECThalves 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_BISECThalves 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
UpdatePipeSourceKinesisStreamParameters.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.
-
-