Class StreamSpecification

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

Represents the DynamoDB Streams configuration for a table in DynamoDB.

See Also:

  • Method Details

    • streamEnabled

      public final Boolean streamEnabled()

      Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

      Returns:
      Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

    • streamViewType

      public final StreamViewType streamViewType()

      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

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

      Returns:
      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

      See Also:

    • streamViewTypeAsString

      public final String streamViewTypeAsString()

      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

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

      Returns:
      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

      See Also:

    • toBuilder

      public StreamSpecification.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<StreamSpecification.Builder,StreamSpecification>
      Returns:
      a builder for type T

    • builder

      public static StreamSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StreamSpecification.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.