@Generated(value="software.amazon.awssdk:codegen") public final class StreamDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
Represents all of the data describing a particular stream.
Modifier and Type | Class and Description |
---|---|
static interface |
StreamDescription.Builder |
Modifier and Type | Method and Description |
---|---|
static StreamDescription.Builder |
builder() |
Instant |
creationRequestDateTime()
The date and time when the request to create this stream was issued.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasKeySchema()
Returns true if the KeySchema property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasShards()
Returns true if the Shards property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
List<KeySchemaElement> |
keySchema()
The key attribute(s) of the stream's DynamoDB table.
|
String |
lastEvaluatedShardId()
The shard ID of the item where the operation stopped, inclusive of the previous result set.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StreamDescription.Builder> |
serializableBuilderClass() |
List<Shard> |
shards()
The shards that comprise the stream.
|
String |
streamArn()
The Amazon Resource Name (ARN) for the stream.
|
String |
streamLabel()
A timestamp, in ISO 8601 format, for this stream.
|
StreamStatus |
streamStatus()
Indicates the current status of the stream:
|
String |
streamStatusAsString()
Indicates the current status of the stream:
|
StreamViewType |
streamViewType()
Indicates the format of the records within this stream:
|
String |
streamViewTypeAsString()
Indicates the format of the records within this stream:
|
String |
tableName()
The DynamoDB table with which the stream is associated.
|
StreamDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String streamArn()
The Amazon Resource Name (ARN) for the stream.
public 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
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 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.
If the service returns an enum value that is not available in the current SDK version, streamStatus
will
return StreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
streamStatusAsString()
.
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 streamStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, streamStatus
will
return StreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
streamStatusAsString()
.
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 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.
If the service returns an enum value that is not available in the current SDK version, streamViewType
will return StreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from streamViewTypeAsString()
.
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 streamViewTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, streamViewType
will return StreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from streamViewTypeAsString()
.
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 Instant creationRequestDateTime()
The date and time when the request to create this stream was issued.
public String tableName()
The DynamoDB table with which the stream is associated.
public boolean hasKeySchema()
public List<KeySchemaElement> keySchema()
The key attribute(s) of the stream's DynamoDB table.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasKeySchema()
to see if a value was sent in this field.
public boolean hasShards()
public List<Shard> shards()
The shards that comprise the stream.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasShards()
to see if a value was sent in this field.
public 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.
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.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
public static StreamDescription.Builder builder()
public static Class<? extends StreamDescription.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2020. All rights reserved.