Class StreamDescription

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

Represents all of the data describing a particular stream.

See Also:

  • Method Details

    • streamArn

      public final String streamArn()

      The Amazon Resource Name (ARN) for the stream.

      Returns:
      The Amazon Resource Name (ARN) for the stream.

    • streamLabel

      public final String streamLabel()

      A timestamp, in ISO 8601 format, for this stream.

      Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

      • the Amazon Web Services customer ID.

      • the table name

      • the StreamLabel

      Returns:
      A timestamp, in ISO 8601 format, for this stream.

      Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

      • the Amazon Web Services customer ID.

      • the table name

      • the StreamLabel

    • streamStatus

      public final StreamStatus streamStatus()

      Indicates the current status of the stream:

      • ENABLING - Streams is currently being enabled on the DynamoDB table.

      • ENABLED - the stream is enabled.

      • DISABLING - Streams is currently being disabled on the DynamoDB table.

      • DISABLED - the stream is disabled.

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

      Returns:
      Indicates the current status of the stream:

      • ENABLING - Streams is currently being enabled on the DynamoDB table.

      • ENABLED - the stream is enabled.

      • DISABLING - Streams is currently being disabled on the DynamoDB table.

      • DISABLED - the stream is disabled.

      See Also:

    • streamStatusAsString

      public final String streamStatusAsString()

      Indicates the current status of the stream:

      • ENABLING - Streams is currently being enabled on the DynamoDB table.

      • ENABLED - the stream is enabled.

      • DISABLING - Streams is currently being disabled on the DynamoDB table.

      • DISABLED - the stream is disabled.

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

      Returns:
      Indicates the current status of the stream:

      • ENABLING - Streams is currently being enabled on the DynamoDB table.

      • ENABLED - the stream is enabled.

      • DISABLING - Streams is currently being disabled on the DynamoDB table.

      • DISABLED - the stream is disabled.

      See Also:

    • streamViewType

      public final StreamViewType streamViewType()

      Indicates the format of the records within this stream:

      • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

      • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

      • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

      • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

      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:
      Indicates the format of the records within this stream:

      • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

      • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

      • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

      • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

      See Also:

    • streamViewTypeAsString

      public final String streamViewTypeAsString()

      Indicates the format of the records within this stream:

      • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

      • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

      • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

      • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

      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:
      Indicates the format of the records within this stream:

      • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

      • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

      • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

      • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

      See Also:

    • creationRequestDateTime

      public final Instant creationRequestDateTime()

      The date and time when the request to create this stream was issued.

      Returns:
      The date and time when the request to create this stream was issued.

    • tableName

      public final String tableName()

      The DynamoDB table with which the stream is associated.

      Returns:
      The DynamoDB table with which the stream is associated.

    • hasKeySchema

      public final boolean hasKeySchema()
      For responses, this returns true if the service returned a value for the KeySchema 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.

    • keySchema

      public final List<KeySchemaElement> keySchema()

      The key attribute(s) of the stream's DynamoDB table.

      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 hasKeySchema() method.

      Returns:
      The key attribute(s) of the stream's DynamoDB table.

    • hasShards

      public final boolean hasShards()
      For responses, this returns true if the service returned a value for the Shards 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.

    • shards

      public final List<Shard> shards()

      The shards that comprise the stream.

      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 hasShards() method.

      Returns:
      The shards that comprise the stream.

    • lastEvaluatedShardId

      public final String lastEvaluatedShardId()

      The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

      If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

      Returns:
      The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

      If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

    • toBuilder

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

    • builder

      public static StreamDescription.Builder builder()

    • serializableBuilderClass

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