public class StreamDescription
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Represents all of the data describing a particular stream.
Modifier and Type | Field and Description |
---|---|
private java.util.Date |
creationRequestDateTime
The date and time when the request to create this stream was issued.
|
private java.util.List<KeySchemaElement> |
keySchema
The key attribute(s) of the stream's DynamoDB table.
|
private java.lang.String |
lastEvaluatedShardId
The shard ID of the item where the operation stopped, inclusive of the
previous result set.
|
private java.util.List<Shard> |
shards
The shards that comprise the stream.
|
private java.lang.String |
streamArn
The Amazon Resource Name (ARN) for the stream.
|
private java.lang.String |
streamLabel
A timestamp, in ISO 8601 format, for this stream.
|
private java.lang.String |
streamStatus
Indicates the current status of the stream:
|
private java.lang.String |
streamViewType
Indicates the format of the records within this stream:
|
private java.lang.String |
tableName
The DynamoDB table with which the stream is associated.
|
Constructor and Description |
---|
StreamDescription() |
Modifier and Type | Method and Description |
---|---|
StreamDescription |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.Date |
getCreationRequestDateTime()
The date and time when the request to create this stream was issued.
|
java.util.List<KeySchemaElement> |
getKeySchema()
The key attribute(s) of the stream's DynamoDB table.
|
java.lang.String |
getLastEvaluatedShardId()
The shard ID of the item where the operation stopped, inclusive of the
previous result set.
|
java.util.List<Shard> |
getShards()
The shards that comprise the stream.
|
java.lang.String |
getStreamArn()
The Amazon Resource Name (ARN) for the stream.
|
java.lang.String |
getStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
java.lang.String |
getStreamStatus()
Indicates the current status of the stream:
|
java.lang.String |
getStreamViewType()
Indicates the format of the records within this stream:
|
java.lang.String |
getTableName()
The DynamoDB table with which the stream is associated.
|
int |
hashCode() |
void |
setCreationRequestDateTime(java.util.Date creationRequestDateTime)
The date and time when the request to create this stream was issued.
|
void |
setKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The key attribute(s) of the stream's DynamoDB table.
|
void |
setLastEvaluatedShardId(java.lang.String lastEvaluatedShardId)
The shard ID of the item where the operation stopped, inclusive of the
previous result set.
|
void |
setShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
|
void |
setStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
void |
setStreamLabel(java.lang.String streamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
void |
setStreamStatus(StreamStatus streamStatus)
Indicates the current status of the stream:
|
void |
setStreamStatus(java.lang.String streamStatus)
Indicates the current status of the stream:
|
void |
setStreamViewType(StreamViewType streamViewType)
Indicates the format of the records within this stream:
|
void |
setStreamViewType(java.lang.String streamViewType)
Indicates the format of the records within this stream:
|
void |
setTableName(java.lang.String tableName)
The DynamoDB table with which the stream is associated.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StreamDescription |
withCreationRequestDateTime(java.util.Date creationRequestDateTime)
The date and time when the request to create this stream was issued.
|
StreamDescription |
withKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The key attribute(s) of the stream's DynamoDB table.
|
StreamDescription |
withKeySchema(KeySchemaElement... keySchema)
The key attribute(s) of the stream's DynamoDB table.
|
StreamDescription |
withLastEvaluatedShardId(java.lang.String lastEvaluatedShardId)
The shard ID of the item where the operation stopped, inclusive of the
previous result set.
|
StreamDescription |
withShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription |
withShards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription |
withStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
StreamDescription |
withStreamLabel(java.lang.String streamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
StreamDescription |
withStreamStatus(StreamStatus streamStatus)
Indicates the current status of the stream:
|
StreamDescription |
withStreamStatus(java.lang.String streamStatus)
Indicates the current status of the stream:
|
StreamDescription |
withStreamViewType(StreamViewType streamViewType)
Indicates the format of the records within this stream:
|
StreamDescription |
withStreamViewType(java.lang.String streamViewType)
Indicates the format of the records within this stream:
|
StreamDescription |
withTableName(java.lang.String tableName)
The DynamoDB table with which the stream is associated.
|
private java.lang.String streamArn
The Amazon Resource Name (ARN) for the stream.
private java.lang.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
private java.lang.String 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.
private java.lang.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 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.
private java.util.Date creationRequestDateTime
The date and time when the request to create this stream was issued.
private java.lang.String tableName
The DynamoDB table with which the stream is associated.
private java.util.List<KeySchemaElement> keySchema
The key attribute(s) of the stream's DynamoDB table.
private java.util.List<Shard> shards
The shards that comprise the stream.
private java.lang.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.
public void setStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public java.lang.String getStreamArn()
The Amazon Resource Name (ARN) for the stream.
public StreamDescription withStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public void setStreamLabel(java.lang.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
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
public java.lang.String 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
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
public StreamDescription withStreamLabel(java.lang.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
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
public void setStreamStatus(java.lang.String 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.
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.
StreamStatus
public java.lang.String 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.
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.
StreamStatus
public StreamDescription withStreamStatus(java.lang.String 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.
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.
StreamStatus
public void setStreamStatus(StreamStatus 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.
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.
StreamStatus
public StreamDescription withStreamStatus(StreamStatus 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.
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.
StreamStatus
public void setStreamViewType(java.lang.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 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.
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.
StreamViewType
public java.lang.String 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.
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.
StreamViewType
public StreamDescription withStreamViewType(java.lang.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 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.
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.
StreamViewType
public void setStreamViewType(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 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.
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.
StreamViewType
public StreamDescription withStreamViewType(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 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.
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.
StreamViewType
public void setCreationRequestDateTime(java.util.Date creationRequestDateTime)
The date and time when the request to create this stream was issued.
creationRequestDateTime
- The date and time when the request to create this stream was
issued.public java.util.Date getCreationRequestDateTime()
The date and time when the request to create this stream was issued.
public StreamDescription withCreationRequestDateTime(java.util.Date creationRequestDateTime)
The date and time when the request to create this stream was issued.
creationRequestDateTime
- The date and time when the request to create this stream was
issued.public void setTableName(java.lang.String tableName)
The DynamoDB table with which the stream is associated.
tableName
- The DynamoDB table with which the stream is associated.public java.lang.String getTableName()
The DynamoDB table with which the stream is associated.
public StreamDescription withTableName(java.lang.String tableName)
The DynamoDB table with which the stream is associated.
tableName
- The DynamoDB table with which the stream is associated.public java.util.List<KeySchemaElement> getKeySchema()
The key attribute(s) of the stream's DynamoDB table.
public void setKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The key attribute(s) of the stream's DynamoDB table.
keySchema
- The key attribute(s) of the stream's DynamoDB table.public StreamDescription withKeySchema(KeySchemaElement... keySchema)
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)
or
withKeySchema(java.util.Collection)
if you want to override the
existing values.
keySchema
- The key attribute(s) of the stream's DynamoDB table.public StreamDescription withKeySchema(java.util.Collection<KeySchemaElement> keySchema)
The key attribute(s) of the stream's DynamoDB table.
keySchema
- The key attribute(s) of the stream's DynamoDB table.public java.util.List<Shard> getShards()
The shards that comprise the stream.
public void setShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.public StreamDescription withShards(Shard... shards)
The shards that comprise the stream.
NOTE: This method appends the values to the existing list (if
any). Use setShards(java.util.Collection)
or
withShards(java.util.Collection)
if you want to override the
existing values.
shards
- The shards that comprise the stream.public StreamDescription withShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.public void setLastEvaluatedShardId(java.lang.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.
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.
public java.lang.String 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 when
LastEvaluatedShardId
is empty.
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.
public StreamDescription withLastEvaluatedShardId(java.lang.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.
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public StreamDescription clone()
clone
in class java.lang.Object