Class StreamDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Represents all of the data describing a particular stream.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The date and time when the request to create this stream was issued.The key attribute(s) of the stream's DynamoDB table.The shard ID of the item where the operation stopped, inclusive of the previous result set.The shards that comprise the stream.The Amazon Resource Name (ARN) for the stream.A timestamp, in ISO 8601 format, for this stream.Indicates the current status of the stream:Indicates the format of the records within this stream:The DynamoDB table with which the stream is associated.int
hashCode()
void
setCreationRequestDateTime
(Date creationRequestDateTime) The date and time when the request to create this stream was issued.void
setKeySchema
(Collection<KeySchemaElement> keySchema) The key attribute(s) of the stream's DynamoDB table.void
setLastEvaluatedShardId
(String lastEvaluatedShardId) The shard ID of the item where the operation stopped, inclusive of the previous result set.void
setShards
(Collection<Shard> shards) The shards that comprise the stream.void
setStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.void
setStreamLabel
(String streamLabel) A timestamp, in ISO 8601 format, for this stream.void
setStreamStatus
(StreamStatus streamStatus) Indicates the current status of the stream:void
setStreamStatus
(String streamStatus) Indicates the current status of the stream:void
setStreamViewType
(StreamViewType streamViewType) Indicates the format of the records within this stream:void
setStreamViewType
(String streamViewType) Indicates the format of the records within this stream:void
setTableName
(String tableName) The DynamoDB table with which the stream is associated.toString()
Returns a string representation of this object; useful for testing and debugging.withCreationRequestDateTime
(Date creationRequestDateTime) The date and time when the request to create this stream was issued.withKeySchema
(KeySchemaElement... keySchema) The key attribute(s) of the stream's DynamoDB table.withKeySchema
(Collection<KeySchemaElement> keySchema) The key attribute(s) of the stream's DynamoDB table.withLastEvaluatedShardId
(String lastEvaluatedShardId) The shard ID of the item where the operation stopped, inclusive of the previous result set.withShards
(Shard... shards) The shards that comprise the stream.withShards
(Collection<Shard> shards) The shards that comprise the stream.withStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.withStreamLabel
(String streamLabel) A timestamp, in ISO 8601 format, for this stream.withStreamStatus
(StreamStatus streamStatus) Indicates the current status of the stream:withStreamStatus
(String streamStatus) Indicates the current status of the stream:withStreamViewType
(StreamViewType streamViewType) Indicates the format of the records within this stream:withStreamViewType
(String streamViewType) Indicates the format of the records within this stream:withTableName
(String tableName) The DynamoDB table with which the stream is associated.
-
Constructor Details
-
StreamDescription
public StreamDescription()
-
-
Method Details
-
setStreamArn
The Amazon Resource Name (ARN) for the stream.
- Parameters:
streamArn
- The Amazon Resource Name (ARN) for the stream.
-
getStreamArn
The Amazon Resource Name (ARN) for the stream.
- Returns:
- The Amazon Resource Name (ARN) for the stream.
-
withStreamArn
The Amazon Resource Name (ARN) for the stream.
- Parameters:
streamArn
- The Amazon Resource Name (ARN) for the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStreamLabel
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
- Parameters:
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
-
-
-
getStreamLabel
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
-
-
-
withStreamLabel
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
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
setStreamStatus
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
- Parameters:
streamStatus
- Indicates the current status of the stream:-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
-
- See Also:
-
-
getStreamStatus
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- 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. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
-
- See Also:
-
-
withStreamStatus
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
- Parameters:
streamStatus
- Indicates the current status of the stream:-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setStreamStatus
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
- Parameters:
streamStatus
- Indicates the current status of the stream:-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
-
- See Also:
-
-
withStreamStatus
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
- Parameters:
streamStatus
- Indicates the current status of the stream:-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLING
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setStreamViewType
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
- Parameters:
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
-
- See Also:
-
-
getStreamViewType
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it 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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
-
- See Also:
-
-
withStreamViewType
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
- Parameters:
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setStreamViewType
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
- Parameters:
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
-
- See Also:
-
-
withStreamViewType
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
- Parameters:
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 item from the table, as it appeared after they were modified. -
OLD_IMAGE
- entire item from the table, as it appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setCreationRequestDateTime
The date and time when the request to create this stream was issued.
- Parameters:
creationRequestDateTime
- The date and time when the request to create this stream was issued.
-
getCreationRequestDateTime
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.
-
withCreationRequestDateTime
The date and time when the request to create this stream was issued.
- Parameters:
creationRequestDateTime
- The date and time when the request to create this stream was issued.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTableName
The DynamoDB table with which the stream is associated.
- Parameters:
tableName
- The DynamoDB table with which the stream is associated.
-
getTableName
The DynamoDB table with which the stream is associated.
- Returns:
- The DynamoDB table with which the stream is associated.
-
withTableName
The DynamoDB table with which the stream is associated.
- Parameters:
tableName
- The DynamoDB table with which the stream is associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getKeySchema
The key attribute(s) of the stream's DynamoDB table.
- Returns:
- The key attribute(s) of the stream's DynamoDB table.
-
setKeySchema
The key attribute(s) of the stream's DynamoDB table.
- Parameters:
keySchema
- The key attribute(s) of the stream's DynamoDB table.
-
withKeySchema
The key attribute(s) of the stream's DynamoDB table.
NOTE: This method appends the values to the existing list (if any). Use
setKeySchema(java.util.Collection)
orwithKeySchema(java.util.Collection)
if you want to override the existing values.- Parameters:
keySchema
- The key attribute(s) of the stream's DynamoDB table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withKeySchema
The key attribute(s) of the stream's DynamoDB table.
- Parameters:
keySchema
- The key attribute(s) of the stream's DynamoDB table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getShards
The shards that comprise the stream.
- Returns:
- The shards that comprise the stream.
-
setShards
The shards that comprise the stream.
- Parameters:
shards
- The shards that comprise the stream.
-
withShards
The shards that comprise the stream.
NOTE: This method appends the values to the existing list (if any). Use
setShards(java.util.Collection)
orwithShards(java.util.Collection)
if you want to override the existing values.- Parameters:
shards
- The shards that comprise the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withShards
The shards that comprise the stream.
- Parameters:
shards
- The shards that comprise the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLastEvaluatedShardId
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.- Parameters:
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.
-
getLastEvaluatedShardId
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.
-
withLastEvaluatedShardId
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-