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

Class StreamDescription

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.StreamDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<StreamDescription.Builder,StreamDescription>

@Generated("software.amazon.awssdk:codegen")
public class StreamDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<StreamDescription.Builder,StreamDescription>

Represents all of the data describing a particular stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamDescription.Builder

Method Summary

Modifier and Type	Method	Description
static StreamDescription.Builder	builder()
Date	creationRequestDateTime()	The date and time when the request to create this stream was issued.
boolean	equals(Object obj)
int	hashCode()
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.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
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.
String	streamStatus()	Indicates the current status of the stream:
String	streamViewType()	Indicates the format of the records within this stream:
String	tableName()	The DynamoDB table with which the stream is associated.
StreamDescription.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

streamArn

public String streamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

streamLabel

public 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 AWS 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 AWS customer ID.

• the table name

• the StreamLabel

streamStatus

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

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 String 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.

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 Date 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 String tableName()

The DynamoDB table with which the stream is associated.

Returns:

The DynamoDB table with which the stream is associated.

keySchema

public List<KeySchemaElement> keySchema()

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

Returns:

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

shards

public List<Shard> shards()

The shards that comprise the stream.

Returns:

The shards that comprise the stream.

lastEvaluatedShardId

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.