* Represents all of the data describing a particular stream. *
* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StreamDescription implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) for the stream. *
*/ private String streamArn; /** ** 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
*
* 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.
*
* 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.
*
* The date and time when the request to create this stream was issued. *
*/ private java.util.Date creationRequestDateTime; /** ** The DynamoDB table with which the stream is associated. *
*/ private String tableName; /** ** The key attribute(s) of the stream's DynamoDB table. *
*/ private java.util.List* The shards that comprise the stream. *
*/ private java.util.List* 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.
*
* The Amazon Resource Name (ARN) for the stream. *
* * @param streamArn * The Amazon Resource Name (ARN) for the stream. */ public void setStreamArn(String streamArn) { this.streamArn = streamArn; } /** ** The Amazon Resource Name (ARN) for the stream. *
* * @return The Amazon Resource Name (ARN) for the stream. */ public String getStreamArn() { return this.streamArn; } /** ** The Amazon Resource Name (ARN) for the stream. *
* * @param streamArn * The Amazon Resource Name (ARN) for the stream. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withStreamArn(String streamArn) { setStreamArn(streamArn); return this; } /** ** 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
*
* 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
*
* 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
*
* 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
*
* 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
*
* 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
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* The date and time when the request to create this stream was issued. *
* * @param creationRequestDateTime * The date and time when the request to create this stream was issued. */ public void setCreationRequestDateTime(java.util.Date creationRequestDateTime) { this.creationRequestDateTime = creationRequestDateTime; } /** ** The date and time when the request to create this stream was issued. *
* * @return The date and time when the request to create this stream was issued. */ public java.util.Date getCreationRequestDateTime() { return this.creationRequestDateTime; } /** ** The date and time when the request to create this stream was issued. *
* * @param creationRequestDateTime * The date and time when the request to create this stream was issued. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withCreationRequestDateTime(java.util.Date creationRequestDateTime) { setCreationRequestDateTime(creationRequestDateTime); return this; } /** ** The DynamoDB table with which the stream is associated. *
* * @param tableName * The DynamoDB table with which the stream is associated. */ public void setTableName(String tableName) { this.tableName = tableName; } /** ** The DynamoDB table with which the stream is associated. *
* * @return The DynamoDB table with which the stream is associated. */ public String getTableName() { return this.tableName; } /** ** The DynamoDB table with which the stream is associated. *
* * @param tableName * The DynamoDB table with which the stream is associated. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withTableName(String tableName) { setTableName(tableName); return this; } /** ** The key attribute(s) of the stream's DynamoDB table. *
* * @return The key attribute(s) of the stream's DynamoDB table. */ public java.util.List* The key attribute(s) of the stream's DynamoDB table. *
* * @param keySchema * The key attribute(s) of the stream's DynamoDB table. */ public void setKeySchema(java.util.Collection* The key attribute(s) of the stream's DynamoDB table. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setKeySchema(java.util.Collection)} or {@link #withKeySchema(java.util.Collection)} if you want to * override the existing values. *
* * @param keySchema * The key attribute(s) of the stream's DynamoDB table. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withKeySchema(KeySchemaElement... keySchema) { if (this.keySchema == null) { setKeySchema(new java.util.ArrayList* The key attribute(s) of the stream's DynamoDB table. *
* * @param keySchema * The key attribute(s) of the stream's DynamoDB table. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withKeySchema(java.util.Collection* The shards that comprise the stream. *
* * @return The shards that comprise the stream. */ public java.util.List* The shards that comprise the stream. *
* * @param shards * The shards that comprise the stream. */ public void setShards(java.util.Collection* The shards that comprise the stream. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setShards(java.util.Collection)} or {@link #withShards(java.util.Collection)} if you want to override the * existing values. *
* * @param shards * The shards that comprise the stream. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withShards(Shard... shards) { if (this.shards == null) { setShards(new java.util.ArrayList* The shards that comprise the stream. *
* * @param shards * The shards that comprise the stream. * @return Returns a reference to this object so that method calls can be chained together. */ public StreamDescription withShards(java.util.Collection* 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 void setLastEvaluatedShardId(String lastEvaluatedShardId) {
this.lastEvaluatedShardId = 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.
*
* 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() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StreamDescription withLastEvaluatedShardId(String lastEvaluatedShardId) {
setLastEvaluatedShardId(lastEvaluatedShardId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStreamArn() != null)
sb.append("StreamArn: ").append(getStreamArn()).append(",");
if (getStreamLabel() != null)
sb.append("StreamLabel: ").append(getStreamLabel()).append(",");
if (getStreamStatus() != null)
sb.append("StreamStatus: ").append(getStreamStatus()).append(",");
if (getStreamViewType() != null)
sb.append("StreamViewType: ").append(getStreamViewType()).append(",");
if (getCreationRequestDateTime() != null)
sb.append("CreationRequestDateTime: ").append(getCreationRequestDateTime()).append(",");
if (getTableName() != null)
sb.append("TableName: ").append(getTableName()).append(",");
if (getKeySchema() != null)
sb.append("KeySchema: ").append(getKeySchema()).append(",");
if (getShards() != null)
sb.append("Shards: ").append(getShards()).append(",");
if (getLastEvaluatedShardId() != null)
sb.append("LastEvaluatedShardId: ").append(getLastEvaluatedShardId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StreamDescription == false)
return false;
StreamDescription other = (StreamDescription) obj;
if (other.getStreamArn() == null ^ this.getStreamArn() == null)
return false;
if (other.getStreamArn() != null && other.getStreamArn().equals(this.getStreamArn()) == false)
return false;
if (other.getStreamLabel() == null ^ this.getStreamLabel() == null)
return false;
if (other.getStreamLabel() != null && other.getStreamLabel().equals(this.getStreamLabel()) == false)
return false;
if (other.getStreamStatus() == null ^ this.getStreamStatus() == null)
return false;
if (other.getStreamStatus() != null && other.getStreamStatus().equals(this.getStreamStatus()) == false)
return false;
if (other.getStreamViewType() == null ^ this.getStreamViewType() == null)
return false;
if (other.getStreamViewType() != null && other.getStreamViewType().equals(this.getStreamViewType()) == false)
return false;
if (other.getCreationRequestDateTime() == null ^ this.getCreationRequestDateTime() == null)
return false;
if (other.getCreationRequestDateTime() != null && other.getCreationRequestDateTime().equals(this.getCreationRequestDateTime()) == false)
return false;
if (other.getTableName() == null ^ this.getTableName() == null)
return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false)
return false;
if (other.getKeySchema() == null ^ this.getKeySchema() == null)
return false;
if (other.getKeySchema() != null && other.getKeySchema().equals(this.getKeySchema()) == false)
return false;
if (other.getShards() == null ^ this.getShards() == null)
return false;
if (other.getShards() != null && other.getShards().equals(this.getShards()) == false)
return false;
if (other.getLastEvaluatedShardId() == null ^ this.getLastEvaluatedShardId() == null)
return false;
if (other.getLastEvaluatedShardId() != null && other.getLastEvaluatedShardId().equals(this.getLastEvaluatedShardId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStreamArn() == null) ? 0 : getStreamArn().hashCode());
hashCode = prime * hashCode + ((getStreamLabel() == null) ? 0 : getStreamLabel().hashCode());
hashCode = prime * hashCode + ((getStreamStatus() == null) ? 0 : getStreamStatus().hashCode());
hashCode = prime * hashCode + ((getStreamViewType() == null) ? 0 : getStreamViewType().hashCode());
hashCode = prime * hashCode + ((getCreationRequestDateTime() == null) ? 0 : getCreationRequestDateTime().hashCode());
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getKeySchema() == null) ? 0 : getKeySchema().hashCode());
hashCode = prime * hashCode + ((getShards() == null) ? 0 : getShards().hashCode());
hashCode = prime * hashCode + ((getLastEvaluatedShardId() == null) ? 0 : getLastEvaluatedShardId().hashCode());
return hashCode;
}
@Override
public StreamDescription clone() {
try {
return (StreamDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dynamodbv2.model.transform.StreamDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}