Interface StreamDescription.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<StreamDescription.Builder,StreamDescription>
,SdkBuilder<StreamDescription.Builder,StreamDescription>
,SdkPojo
- Enclosing class:
- StreamDescription
public static interface StreamDescription.Builder extends SdkPojo, CopyableBuilder<StreamDescription.Builder,StreamDescription>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StreamDescription.Builder
creationRequestDateTime(Instant creationRequestDateTime)
The date and time when the request to create this stream was issued.StreamDescription.Builder
keySchema(Collection<KeySchemaElement> keySchema)
The key attribute(s) of the stream's DynamoDB table.StreamDescription.Builder
keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The key attribute(s) of the stream's DynamoDB table.StreamDescription.Builder
keySchema(KeySchemaElement... keySchema)
The key attribute(s) of the stream's DynamoDB table.StreamDescription.Builder
lastEvaluatedShardId(String lastEvaluatedShardId)
The shard ID of the item where the operation stopped, inclusive of the previous result set.StreamDescription.Builder
shards(Collection<Shard> shards)
The shards that comprise the stream.StreamDescription.Builder
shards(Consumer<Shard.Builder>... shards)
The shards that comprise the stream.StreamDescription.Builder
shards(Shard... shards)
The shards that comprise the stream.StreamDescription.Builder
streamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.StreamDescription.Builder
streamLabel(String streamLabel)
A timestamp, in ISO 8601 format, for this stream.StreamDescription.Builder
streamStatus(String streamStatus)
Indicates the current status of the stream:StreamDescription.Builder
streamStatus(StreamStatus streamStatus)
Indicates the current status of the stream:StreamDescription.Builder
streamViewType(String streamViewType)
Indicates the format of the records within this stream:StreamDescription.Builder
streamViewType(StreamViewType streamViewType)
Indicates the format of the records within this stream:StreamDescription.Builder
tableName(String tableName)
The DynamoDB table with which the stream is associated.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
streamArn
StreamDescription.Builder streamArn(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.
-
streamLabel
StreamDescription.Builder streamLabel(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 Amazon Web Services 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 Amazon Web Services customer ID.
-
the table name
-
the
StreamLabel
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
streamStatus
StreamDescription.Builder streamStatus(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StreamStatus
,StreamStatus
-
-
streamStatus
StreamDescription.Builder streamStatus(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StreamStatus
,StreamStatus
-
-
streamViewType
StreamDescription.Builder streamViewType(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.
- 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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StreamViewType
,StreamViewType
-
-
streamViewType
StreamDescription.Builder streamViewType(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.
- 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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StreamViewType
,StreamViewType
-
-
creationRequestDateTime
StreamDescription.Builder creationRequestDateTime(Instant 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.
-
tableName
StreamDescription.Builder tableName(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.
-
keySchema
StreamDescription.Builder keySchema(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.
-
keySchema
StreamDescription.Builder keySchema(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.
-
keySchema
StreamDescription.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The key attribute(s) of the stream's DynamoDB table.
This is a convenience method that creates an instance of theKeySchemaElement.Builder
avoiding the need to create one manually viaKeySchemaElement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#keySchema(List
.) - Parameters:
keySchema
- a consumer that will call methods onKeySchemaElement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#keySchema(java.util.Collection
)
-
shards
StreamDescription.Builder shards(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.
-
shards
StreamDescription.Builder shards(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.
-
shards
StreamDescription.Builder shards(Consumer<Shard.Builder>... shards)
The shards that comprise the stream.
This is a convenience method that creates an instance of theShard.Builder
avoiding the need to create one manually viaShard.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#shards(List
.) - Parameters:
shards
- a consumer that will call methods onShard.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#shards(java.util.Collection
)
-
lastEvaluatedShardId
StreamDescription.Builder lastEvaluatedShardId(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 whenLastEvaluatedShardId
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 whenLastEvaluatedShardId
is empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-