Package software.amazon.awssdk.services.dynamodb.model

Class StreamRecord

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

A description of a single data modification that was performed on an item in a DynamoDB table.

See Also:

  • Method Details

    • approximateCreationDateTime

      public final Instant approximateCreationDateTime()

      The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.

      Returns:
      The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.

    • hasKeys

      public final boolean hasKeys()
      For responses, this returns true if the service returned a value for the Keys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • keys

      public final Map<String,AttributeValue> keys()

      The primary key attribute(s) for the DynamoDB item that was modified.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKeys() method.

      Returns:
      The primary key attribute(s) for the DynamoDB item that was modified.

    • hasNewImage

      public final boolean hasNewImage()
      For responses, this returns true if the service returned a value for the NewImage property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • newImage

      public final Map<String,AttributeValue> newImage()

      The item in the DynamoDB table as it appeared after it was modified.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNewImage() method.

      Returns:
      The item in the DynamoDB table as it appeared after it was modified.

    • hasOldImage

      public final boolean hasOldImage()
      For responses, this returns true if the service returned a value for the OldImage property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • oldImage

      public final Map<String,AttributeValue> oldImage()

      The item in the DynamoDB table as it appeared before it was modified.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOldImage() method.

      Returns:
      The item in the DynamoDB table as it appeared before it was modified.

    • sequenceNumber

      public final String sequenceNumber()

      The sequence number of the stream record.

      Returns:
      The sequence number of the stream record.

    • sizeBytes

      public final Long sizeBytes()

      The size of the stream record, in bytes.

      Returns:
      The size of the stream record, in bytes.

    • streamViewType

      public final StreamViewType streamViewType()

      The type of data from the modified DynamoDB item that was captured in this stream record:

      • KEYS_ONLY - only the key attributes of the modified item.

      • NEW_IMAGE - the entire item, as it appeared after it was modified.

      • OLD_IMAGE - the entire item, as it appeared before it was modified.

      • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

      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:
      The type of data from the modified DynamoDB item that was captured in this stream record:

      • KEYS_ONLY - only the key attributes of the modified item.

      • NEW_IMAGE - the entire item, as it appeared after it was modified.

      • OLD_IMAGE - the entire item, as it appeared before it was modified.

      • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

      See Also:

    • streamViewTypeAsString

      public final String streamViewTypeAsString()

      The type of data from the modified DynamoDB item that was captured in this stream record:

      • KEYS_ONLY - only the key attributes of the modified item.

      • NEW_IMAGE - the entire item, as it appeared after it was modified.

      • OLD_IMAGE - the entire item, as it appeared before it was modified.

      • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

      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:
      The type of data from the modified DynamoDB item that was captured in this stream record:

      • KEYS_ONLY - only the key attributes of the modified item.

      • NEW_IMAGE - the entire item, as it appeared after it was modified.

      • OLD_IMAGE - the entire item, as it appeared before it was modified.

      • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

      See Also:

    • toBuilder

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

    • builder

      public static StreamRecord.Builder builder()

    • serializableBuilderClass

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