Interface StartingPosition.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<StartingPosition.Builder,StartingPosition>
,SdkBuilder<StartingPosition.Builder,StartingPosition>
,SdkPojo
- Enclosing class:
- StartingPosition
public static interface StartingPosition.Builder extends SdkPojo, CopyableBuilder<StartingPosition.Builder,StartingPosition>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StartingPosition.Builder
sequenceNumber(String sequenceNumber)
The sequence number of the data record in the shard from which to start streaming.StartingPosition.Builder
timestamp(Instant timestamp)
The time stamp of the data record from which to start reading.StartingPosition.Builder
type(String type)
You can set the starting position to one of the following values:StartingPosition.Builder
type(ShardIteratorType type)
You can set the starting position to one of the following values:-
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
-
type
StartingPosition.Builder type(String type)
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the sequence number specified in theSequenceNumber
field.AFTER_SEQUENCE_NUMBER
: Start streaming right after the position denoted by the sequence number specified in theSequenceNumber
field.AT_TIMESTAMP
: Start streaming from the position denoted by the time stamp specified in theTimestamp
field.TRIM_HORIZON
: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.LATEST
: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.- Parameters:
type
- You can set the starting position to one of the following values:AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the sequence number specified in theSequenceNumber
field.AFTER_SEQUENCE_NUMBER
: Start streaming right after the position denoted by the sequence number specified in theSequenceNumber
field.AT_TIMESTAMP
: Start streaming from the position denoted by the time stamp specified in theTimestamp
field.TRIM_HORIZON
: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.LATEST
: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShardIteratorType
,ShardIteratorType
-
type
StartingPosition.Builder type(ShardIteratorType type)
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the sequence number specified in theSequenceNumber
field.AFTER_SEQUENCE_NUMBER
: Start streaming right after the position denoted by the sequence number specified in theSequenceNumber
field.AT_TIMESTAMP
: Start streaming from the position denoted by the time stamp specified in theTimestamp
field.TRIM_HORIZON
: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.LATEST
: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.- Parameters:
type
- You can set the starting position to one of the following values:AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the sequence number specified in theSequenceNumber
field.AFTER_SEQUENCE_NUMBER
: Start streaming right after the position denoted by the sequence number specified in theSequenceNumber
field.AT_TIMESTAMP
: Start streaming from the position denoted by the time stamp specified in theTimestamp
field.TRIM_HORIZON
: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.LATEST
: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShardIteratorType
,ShardIteratorType
-
sequenceNumber
StartingPosition.Builder sequenceNumber(String sequenceNumber)
The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set
StartingPosition
toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
.- Parameters:
sequenceNumber
- The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, setStartingPosition
toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timestamp
StartingPosition.Builder timestamp(Instant timestamp)
The time stamp of the data record from which to start reading. To specify a time stamp, set
StartingPosition
toType AT_TIMESTAMP
. A time stamp is the Unix epoch date with precision in milliseconds. For example,2016-04-04T19:58:46.480-00:00
or1459799926.480
. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON
).- Parameters:
timestamp
- The time stamp of the data record from which to start reading. To specify a time stamp, setStartingPosition
toType AT_TIMESTAMP
. A time stamp is the Unix epoch date with precision in milliseconds. For example,2016-04-04T19:58:46.480-00:00
or1459799926.480
. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-