@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StreamDescription extends Object implements Serializable, Cloneable, StructuredPojo
Represents all of the data describing a particular stream.
Constructor and Description |
---|
StreamDescription() |
Modifier and Type | Method and Description |
---|---|
StreamDescription |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationRequestDateTime()
The date and time when the request to create this stream was issued.
|
List<KeySchemaElement> |
getKeySchema()
The key attribute(s) of the stream's DynamoDB table.
|
String |
getLastEvaluatedShardId()
The shard ID of the item where the operation stopped, inclusive of the previous result set.
|
List<Shard> |
getShards()
The shards that comprise the stream.
|
String |
getStreamArn()
The Amazon Resource Name (ARN) for the stream.
|
String |
getStreamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
String |
getStreamStatus()
Indicates the current status of the stream:
|
String |
getStreamViewType()
Indicates the format of the records within this stream:
|
String |
getTableName()
The DynamoDB table with which the stream is associated.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
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.
|
String |
toString()
Returns a string representation of this object.
|
StreamDescription |
withCreationRequestDateTime(Date creationRequestDateTime)
The date and time when the request to create this stream was issued.
|
StreamDescription |
withKeySchema(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(String lastEvaluatedShardId)
The shard ID of the item where the operation stopped, inclusive of the previous result set.
|
StreamDescription |
withShards(Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription |
withShards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription |
withStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
StreamDescription |
withStreamLabel(String streamLabel)
A timestamp, in ISO 8601 format, for this stream.
|
StreamDescription |
withStreamStatus(StreamStatus streamStatus)
Indicates the current status of the stream:
|
StreamDescription |
withStreamStatus(String streamStatus)
Indicates the current status of the stream:
|
StreamDescription |
withStreamViewType(StreamViewType streamViewType)
Indicates the format of the records within this stream:
|
StreamDescription |
withStreamViewType(String streamViewType)
Indicates the format of the records within this stream:
|
StreamDescription |
withTableName(String tableName)
The DynamoDB table with which the stream is associated.
|
public void setStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public String getStreamArn()
The Amazon Resource Name (ARN) for the stream.
public StreamDescription withStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public void setStreamLabel(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 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(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(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.
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.
StreamStatus
public String getStreamStatus()
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.
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.
StreamStatus
public StreamDescription withStreamStatus(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.
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.
StreamStatus
public void setStreamStatus(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.
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.
StreamStatus
public StreamDescription withStreamStatus(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.
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.
StreamStatus
public void setStreamViewType(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.
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.
StreamViewType
public 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 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.
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.
StreamViewType
public StreamDescription withStreamViewType(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.
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.
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 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.
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.
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 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.
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.
StreamViewType
public void setCreationRequestDateTime(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 Date getCreationRequestDateTime()
The date and time when the request to create this stream was issued.
public StreamDescription withCreationRequestDateTime(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(String tableName)
The DynamoDB table with which the stream is associated.
tableName
- The DynamoDB table with which the stream is associated.public String getTableName()
The DynamoDB table with which the stream is associated.
public StreamDescription withTableName(String tableName)
The DynamoDB table with which the stream is associated.
tableName
- The DynamoDB table with which the stream is associated.public List<KeySchemaElement> getKeySchema()
The key attribute(s) of the stream's DynamoDB table.
public void setKeySchema(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(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 List<Shard> getShards()
The shards that comprise the stream.
public void setShards(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(Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.public void setLastEvaluatedShardId(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 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(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 String toString()
toString
in class Object
Object.toString()
public StreamDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2023. All rights reserved.