Package software.amazon.awssdk.services.pipes.model

Interface PipeSourceKinesisStreamParameters.Builder

    • Method Detail

      • batchSize

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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.

      • maximumBatchingWindowInSeconds

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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

        PipeSourceKinesisStreamParameters.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.

      • startingPositionTimestamp

        PipeSourceKinesisStreamParameters.Builder startingPositionTimestamp​(Instant startingPositionTimestamp)

        With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

        Parameters:
        startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.