AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::Kinesis::Model::StartingPosition Class Reference

#include <StartingPosition.h>

Public Member Functions

 StartingPosition ()
 
 StartingPosition (Aws::Utils::Json::JsonView jsonValue)
 
StartingPositionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ShardIteratorTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ShardIteratorType &value)
 
void SetType (ShardIteratorType &&value)
 
StartingPositionWithType (const ShardIteratorType &value)
 
StartingPositionWithType (ShardIteratorType &&value)
 
const Aws::StringGetSequenceNumber () const
 
bool SequenceNumberHasBeenSet () const
 
void SetSequenceNumber (const Aws::String &value)
 
void SetSequenceNumber (Aws::String &&value)
 
void SetSequenceNumber (const char *value)
 
StartingPositionWithSequenceNumber (const Aws::String &value)
 
StartingPositionWithSequenceNumber (Aws::String &&value)
 
StartingPositionWithSequenceNumber (const char *value)
 
const Aws::Utils::DateTimeGetTimestamp () const
 
bool TimestampHasBeenSet () const
 
void SetTimestamp (const Aws::Utils::DateTime &value)
 
void SetTimestamp (Aws::Utils::DateTime &&value)
 
StartingPositionWithTimestamp (const Aws::Utils::DateTime &value)
 
StartingPositionWithTimestamp (Aws::Utils::DateTime &&value)
 

Detailed Description

See Also:

AWS API Reference

Definition at line 33 of file StartingPosition.h.

Constructor & Destructor Documentation

◆ StartingPosition() [1/2]

Aws::Kinesis::Model::StartingPosition::StartingPosition ( )

◆ StartingPosition() [2/2]

Aws::Kinesis::Model::StartingPosition::StartingPosition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetSequenceNumber()

const Aws::String& Aws::Kinesis::Model::StartingPosition::GetSequenceNumber ( ) const
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 138 of file StartingPosition.h.

◆ GetTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::StartingPosition::GetTimestamp ( ) const
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 200 of file StartingPosition.h.

◆ GetType()

const ShardIteratorType& Aws::Kinesis::Model::StartingPosition::GetType ( ) const
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 55 of file StartingPosition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Kinesis::Model::StartingPosition::Jsonize ( ) const

◆ operator=()

StartingPosition& Aws::Kinesis::Model::StartingPosition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SequenceNumberHasBeenSet()

bool Aws::Kinesis::Model::StartingPosition::SequenceNumberHasBeenSet ( ) const
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 145 of file StartingPosition.h.

◆ SetSequenceNumber() [1/3]

void Aws::Kinesis::Model::StartingPosition::SetSequenceNumber ( Aws::String &&  value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 159 of file StartingPosition.h.

◆ SetSequenceNumber() [2/3]

void Aws::Kinesis::Model::StartingPosition::SetSequenceNumber ( const Aws::String value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 152 of file StartingPosition.h.

◆ SetSequenceNumber() [3/3]

void Aws::Kinesis::Model::StartingPosition::SetSequenceNumber ( const char *  value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 166 of file StartingPosition.h.

◆ SetTimestamp() [1/2]

void Aws::Kinesis::Model::StartingPosition::SetTimestamp ( Aws::Utils::DateTime &&  value)
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 236 of file StartingPosition.h.

◆ SetTimestamp() [2/2]

void Aws::Kinesis::Model::StartingPosition::SetTimestamp ( const Aws::Utils::DateTime value)
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 224 of file StartingPosition.h.

◆ SetType() [1/2]

void Aws::Kinesis::Model::StartingPosition::SetType ( const ShardIteratorType value)
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 85 of file StartingPosition.h.

◆ SetType() [2/2]

void Aws::Kinesis::Model::StartingPosition::SetType ( ShardIteratorType &&  value)
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 100 of file StartingPosition.h.

◆ TimestampHasBeenSet()

bool Aws::Kinesis::Model::StartingPosition::TimestampHasBeenSet ( ) const
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 212 of file StartingPosition.h.

◆ TypeHasBeenSet()

bool Aws::Kinesis::Model::StartingPosition::TypeHasBeenSet ( ) const
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 70 of file StartingPosition.h.

◆ WithSequenceNumber() [1/3]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithSequenceNumber ( Aws::String &&  value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 180 of file StartingPosition.h.

◆ WithSequenceNumber() [2/3]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithSequenceNumber ( const Aws::String value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 173 of file StartingPosition.h.

◆ WithSequenceNumber() [3/3]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithSequenceNumber ( const char *  value)
inline

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Definition at line 187 of file StartingPosition.h.

◆ WithTimestamp() [1/2]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithTimestamp ( Aws::Utils::DateTime &&  value)
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 260 of file StartingPosition.h.

◆ WithTimestamp() [2/2]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithTimestamp ( const Aws::Utils::DateTime value)
inline

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.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).

Definition at line 248 of file StartingPosition.h.

◆ WithType() [1/2]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithType ( const ShardIteratorType value)
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 115 of file StartingPosition.h.

◆ WithType() [2/2]

StartingPosition& Aws::Kinesis::Model::StartingPosition::WithType ( ShardIteratorType &&  value)
inline

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Definition at line 130 of file StartingPosition.h.


The documentation for this class was generated from the following file: