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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StreamDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StreamDescription.Builder
builder()
Instant
creationRequestDateTime()
The date and time when the request to create this stream was issued.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasKeySchema()
For responses, this returns true if the service returned a value for the KeySchema property.boolean
hasShards()
For responses, this returns true if the service returned a value for the Shards property.List<KeySchemaElement>
keySchema()
The key attribute(s) of the stream's DynamoDB table.String
lastEvaluatedShardId()
The shard ID of the item where the operation stopped, inclusive of the previous result set.List<SdkField<?>>
sdkFields()
static Class<? extends StreamDescription.Builder>
serializableBuilderClass()
List<Shard>
shards()
The shards that comprise the stream.String
streamArn()
The Amazon Resource Name (ARN) for the stream.String
streamLabel()
A timestamp, in ISO 8601 format, for this stream.StreamStatus
streamStatus()
Indicates the current status of the stream:String
streamStatusAsString()
Indicates the current status of the stream:StreamViewType
streamViewType()
Indicates the format of the records within this stream:String
streamViewTypeAsString()
Indicates the format of the records within this stream:String
tableName()
The DynamoDB table with which the stream is associated.StreamDescription.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- 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:
StreamStatus
-
-
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 returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- 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:
StreamStatus
-
-
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 returnStreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamViewTypeAsString()
.- 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:
StreamViewType
-
-
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 returnStreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamViewTypeAsString()
.- 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:
StreamViewType
-
-
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 theisEmpty()
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 theisEmpty()
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 whenLastEvaluatedShardId
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 whenLastEvaluatedShardId
is empty.
-
toBuilder
public StreamDescription.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StreamDescription.Builder,StreamDescription>
-
builder
public static StreamDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends StreamDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-