Class PipeSourceDynamoDBStreamParameters

java.lang.Object
software.amazon.awssdk.services.pipes.model.PipeSourceDynamoDBStreamParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipeSourceDynamoDBStreamParameters.Builder,PipeSourceDynamoDBStreamParameters>
@Generated("software.amazon.awssdk:codegen") public final class PipeSourceDynamoDBStreamParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipeSourceDynamoDBStreamParameters.Builder,PipeSourceDynamoDBStreamParameters>

The parameters for using a DynamoDB stream as a source.

See Also:

  • Method Details

    • batchSize

      public final Integer batchSize()

      The maximum number of records to include in each batch.

      Returns:
      The maximum number of records to include in each batch.

    • deadLetterConfig

      public final DeadLetterConfig deadLetterConfig()

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

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

    • onPartialBatchItemFailure

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, onPartialBatchItemFailure will return OnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onPartialBatchItemFailureAsString().

      Returns:
      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.
      See Also:

    • onPartialBatchItemFailureAsString

      public final String onPartialBatchItemFailureAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, onPartialBatchItemFailure will return OnPartialBatchItemFailureStreams.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onPartialBatchItemFailureAsString().

      Returns:
      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.
      See Also:

    • maximumBatchingWindowInSeconds

      public final Integer maximumBatchingWindowInSeconds()

      The maximum length of a time to wait for events.

      Returns:
      The maximum length of a time to wait for events.

    • maximumRecordAgeInSeconds

      public final 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.

      Returns:
      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.

    • maximumRetryAttempts

      public final Integer 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:
      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.

    • parallelizationFactor

      public final Integer parallelizationFactor()

      The number of batches to process concurrently from each shard. The default value is 1.

      Returns:
      The number of batches to process concurrently from each shard. The default value is 1.

    • startingPosition

      public final DynamoDBStreamStartPosition startingPosition()

      The position in a stream from which to start reading.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return DynamoDBStreamStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The position in a stream from which to start reading.
      See Also:

    • startingPositionAsString

      public final String startingPositionAsString()

      The position in a stream from which to start reading.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return DynamoDBStreamStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The position in a stream from which to start reading.
      See Also:

    • toBuilder

      public PipeSourceDynamoDBStreamParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipeSourceDynamoDBStreamParameters.Builder,PipeSourceDynamoDBStreamParameters>
      Returns:
      a builder for type T

    • builder

      public static PipeSourceDynamoDBStreamParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipeSourceDynamoDBStreamParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.