Class StreamDescription

    • Constructor Detail

      • StreamDescription

        public StreamDescription()
    • Method Detail

      • setStreamArn

        public void setStreamArn​(String streamArn)

        The Amazon Resource Name (ARN) for the stream.

        Parameters:
        streamArn - The Amazon Resource Name (ARN) for the stream.
      • getStreamArn

        public String getStreamArn()

        The Amazon Resource Name (ARN) for the stream.

        Returns:
        The Amazon Resource Name (ARN) for the stream.
      • withStreamArn

        public StreamDescription withStreamArn​(String streamArn)

        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

        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

        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

        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

        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

        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

        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

        public void setStreamStatus​(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.

        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:
        StreamStatus
      • getStreamStatus

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

        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:
        StreamStatus
      • withStreamStatus

        public StreamDescription withStreamStatus​(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.

        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:
        StreamStatus
      • setStreamStatus

        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.

        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:
        StreamStatus
      • withStreamStatus

        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.

        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:
        StreamStatus
      • setStreamViewType

        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 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:
        StreamViewType
      • getStreamViewType

        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 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:
        StreamViewType
      • withStreamViewType

        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 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:
        StreamViewType
      • setStreamViewType

        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.

        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:
        StreamViewType
      • withStreamViewType

        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.

        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:
        StreamViewType
      • setCreationRequestDateTime

        public void setCreationRequestDateTime​(Date creationRequestDateTime)

        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

        public Date 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

        public StreamDescription withCreationRequestDateTime​(Date creationRequestDateTime)

        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

        public void setTableName​(String tableName)

        The DynamoDB table with which the stream is associated.

        Parameters:
        tableName - The DynamoDB table with which the stream is associated.
      • getTableName

        public String getTableName()

        The DynamoDB table with which the stream is associated.

        Returns:
        The DynamoDB table with which the stream is associated.
      • withTableName

        public StreamDescription withTableName​(String tableName)

        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

        public List<KeySchemaElement> getKeySchema()

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

        Returns:
        The key attribute(s) of the stream's DynamoDB table.
      • setKeySchema

        public void setKeySchema​(Collection<KeySchemaElement> keySchema)

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

        Parameters:
        keySchema - The key attribute(s) of the stream's DynamoDB table.
      • withKeySchema

        public StreamDescription withKeySchema​(Collection<KeySchemaElement> keySchema)

        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

        public List<Shard> getShards()

        The shards that comprise the stream.

        Returns:
        The shards that comprise the stream.
      • setShards

        public void setShards​(Collection<Shard> shards)

        The shards that comprise the stream.

        Parameters:
        shards - The shards that comprise the stream.
      • withShards

        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.

        Parameters:
        shards - The shards that comprise the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withShards

        public StreamDescription withShards​(Collection<Shard> shards)

        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

        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.

        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 when LastEvaluatedShardId is empty.

      • getLastEvaluatedShardId

        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.

        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.

      • withLastEvaluatedShardId

        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.

        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 when LastEvaluatedShardId is empty.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object