/AWS1/CL_KNSSTARTINGPOSITION¶
The starting position in the data stream from which to start streaming.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_type
TYPE /AWS1/KNSSHARDITERATORTYPE
/AWS1/KNSSHARDITERATORTYPE
¶
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.
Optional arguments:¶
iv_sequencenumber
TYPE /AWS1/KNSSEQUENCENUMBER
/AWS1/KNSSEQUENCENUMBER
¶
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
.
iv_timestamp
TYPE /AWS1/KNSTIMESTAMP
/AWS1/KNSTIMESTAMP
¶
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
).
Queryable Attributes¶
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
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
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SEQUENCENUMBER() |
Getter for SEQUENCENUMBER, with configurable default |
ASK_SEQUENCENUMBER() |
Getter for SEQUENCENUMBER w/ exceptions if field has no valu |
HAS_SEQUENCENUMBER() |
Determine if SEQUENCENUMBER has a value |
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
).
Accessible with the following methods¶
Method | Description |
---|---|
GET_TIMESTAMP() |
Getter for TIMESTAMP, with configurable default |
ASK_TIMESTAMP() |
Getter for TIMESTAMP w/ exceptions if field has no value |
HAS_TIMESTAMP() |
Determine if TIMESTAMP has a value |