Aws::Kinesis::Model::GetShardIteratorRequest Class Reference

#include <GetShardIteratorRequest.h>

Inheritance diagram for Aws::Kinesis::Model::GetShardIteratorRequest:

Public Member Functions
	GetShardIteratorRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetStreamName () const
bool	StreamNameHasBeenSet () const
void	SetStreamName (const Aws::String &value)
void	SetStreamName (Aws::String &&value)
void	SetStreamName (const char *value)
GetShardIteratorRequest &	WithStreamName (const Aws::String &value)
GetShardIteratorRequest &	WithStreamName (Aws::String &&value)
GetShardIteratorRequest &	WithStreamName (const char *value)
const Aws::String &	GetShardId () const
bool	ShardIdHasBeenSet () const
void	SetShardId (const Aws::String &value)
void	SetShardId (Aws::String &&value)
void	SetShardId (const char *value)
GetShardIteratorRequest &	WithShardId (const Aws::String &value)
GetShardIteratorRequest &	WithShardId (Aws::String &&value)
GetShardIteratorRequest &	WithShardId (const char *value)
const ShardIteratorType &	GetShardIteratorType () const
bool	ShardIteratorTypeHasBeenSet () const
void	SetShardIteratorType (const ShardIteratorType &value)
void	SetShardIteratorType (ShardIteratorType &&value)
GetShardIteratorRequest &	WithShardIteratorType (const ShardIteratorType &value)
GetShardIteratorRequest &	WithShardIteratorType (ShardIteratorType &&value)
const Aws::String &	GetStartingSequenceNumber () const
bool	StartingSequenceNumberHasBeenSet () const
void	SetStartingSequenceNumber (const Aws::String &value)
void	SetStartingSequenceNumber (Aws::String &&value)
void	SetStartingSequenceNumber (const char *value)
GetShardIteratorRequest &	WithStartingSequenceNumber (const Aws::String &value)
GetShardIteratorRequest &	WithStartingSequenceNumber (Aws::String &&value)
GetShardIteratorRequest &	WithStartingSequenceNumber (const char *value)
const Aws::Utils::DateTime &	GetTimestamp () const
bool	TimestampHasBeenSet () const
void	SetTimestamp (const Aws::Utils::DateTime &value)
void	SetTimestamp (Aws::Utils::DateTime &&value)
GetShardIteratorRequest &	WithTimestamp (const Aws::Utils::DateTime &value)
GetShardIteratorRequest &	WithTimestamp (Aws::Utils::DateTime &&value)
Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual	~KinesisRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Represents the input for GetShardIterator.

See Also:

AWS API Reference

Definition at line 27 of file GetShardIteratorRequest.h.

Constructor & Destructor Documentation

GetShardIteratorRequest()

Aws::Kinesis::Model::GetShardIteratorRequest::GetShardIteratorRequest

(

)

Member Function Documentation

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::GetShardIteratorRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::GetShardIteratorRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetShardIteratorRequest.h.

GetShardId()

const Aws::String& Aws::Kinesis::Model::GetShardIteratorRequest::GetShardId ( ) const

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 87 of file GetShardIteratorRequest.h.

GetShardIteratorType()

const ShardIteratorType& Aws::Kinesis::Model::GetShardIteratorRequest::GetShardIteratorType ( ) const

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 140 of file GetShardIteratorRequest.h.

GetStartingSequenceNumber()

const Aws::String& Aws::Kinesis::Model::GetShardIteratorRequest::GetStartingSequenceNumber ( ) const

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 233 of file GetShardIteratorRequest.h.

GetStreamName()

const Aws::String& Aws::Kinesis::Model::GetShardIteratorRequest::GetStreamName ( ) const

inline

The name of the Amazon Kinesis data stream.

Definition at line 46 of file GetShardIteratorRequest.h.

GetTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::GetShardIteratorRequest::GetTimestamp ( ) const

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 295 of file GetShardIteratorRequest.h.

SerializePayload()

Aws::String Aws::Kinesis::Model::GetShardIteratorRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetShardId() [1/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId ( const Aws::String &  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 97 of file GetShardIteratorRequest.h.

SetShardId() [2/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId ( Aws::String &&  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 102 of file GetShardIteratorRequest.h.

SetShardId() [3/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId ( const char *  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 107 of file GetShardIteratorRequest.h.

SetShardIteratorType() [1/2]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetShardIteratorType ( const ShardIteratorType &  value )

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 174 of file GetShardIteratorRequest.h.

SetShardIteratorType() [2/2]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetShardIteratorType ( ShardIteratorType &&  value )

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 191 of file GetShardIteratorRequest.h.

SetStartingSequenceNumber() [1/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber ( const Aws::String &  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 247 of file GetShardIteratorRequest.h.

SetStartingSequenceNumber() [2/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber ( Aws::String &&  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 254 of file GetShardIteratorRequest.h.

SetStartingSequenceNumber() [3/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber ( const char *  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 261 of file GetShardIteratorRequest.h.

SetStreamName() [1/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName ( const Aws::String &  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 56 of file GetShardIteratorRequest.h.

SetStreamName() [2/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName ( Aws::String &&  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 61 of file GetShardIteratorRequest.h.

SetStreamName() [3/3]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName ( const char *  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 66 of file GetShardIteratorRequest.h.

SetTimestamp() [1/2]

void Aws::Kinesis::Model::GetShardIteratorRequest::SetTimestamp ( const Aws::Utils::DateTime &  value )

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 319 of file GetShardIteratorRequest.h.

SetTimestamp() [2/2]

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

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 331 of file GetShardIteratorRequest.h.

ShardIdHasBeenSet()

bool Aws::Kinesis::Model::GetShardIteratorRequest::ShardIdHasBeenSet ( ) const

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 92 of file GetShardIteratorRequest.h.

ShardIteratorTypeHasBeenSet()

bool Aws::Kinesis::Model::GetShardIteratorRequest::ShardIteratorTypeHasBeenSet ( ) const

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 157 of file GetShardIteratorRequest.h.

StartingSequenceNumberHasBeenSet()

bool Aws::Kinesis::Model::GetShardIteratorRequest::StartingSequenceNumberHasBeenSet ( ) const

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 240 of file GetShardIteratorRequest.h.

StreamNameHasBeenSet()

bool Aws::Kinesis::Model::GetShardIteratorRequest::StreamNameHasBeenSet ( ) const

inline

The name of the Amazon Kinesis data stream.

Definition at line 51 of file GetShardIteratorRequest.h.

TimestampHasBeenSet()

bool Aws::Kinesis::Model::GetShardIteratorRequest::TimestampHasBeenSet ( ) const

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 307 of file GetShardIteratorRequest.h.

WithShardId() [1/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId ( const Aws::String &  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 112 of file GetShardIteratorRequest.h.

WithShardId() [2/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId ( Aws::String &&  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 117 of file GetShardIteratorRequest.h.

WithShardId() [3/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId ( const char *  value )

inline

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Definition at line 122 of file GetShardIteratorRequest.h.

WithShardIteratorType() [1/2]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithShardIteratorType ( const ShardIteratorType &  value )

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 208 of file GetShardIteratorRequest.h.

WithShardIteratorType() [2/2]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithShardIteratorType ( ShardIteratorType &&  value )

inline

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Definition at line 225 of file GetShardIteratorRequest.h.

WithStartingSequenceNumber() [1/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber ( const Aws::String &  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 268 of file GetShardIteratorRequest.h.

WithStartingSequenceNumber() [2/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber ( Aws::String &&  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 275 of file GetShardIteratorRequest.h.

WithStartingSequenceNumber() [3/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber ( const char *  value )

inline

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Definition at line 282 of file GetShardIteratorRequest.h.

WithStreamName() [1/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName ( const Aws::String &  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 71 of file GetShardIteratorRequest.h.

WithStreamName() [2/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName ( Aws::String &&  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 76 of file GetShardIteratorRequest.h.

WithStreamName() [3/3]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName ( const char *  value )

inline

The name of the Amazon Kinesis data stream.

Definition at line 81 of file GetShardIteratorRequest.h.

WithTimestamp() [1/2]

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

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 343 of file GetShardIteratorRequest.h.

WithTimestamp() [2/2]

GetShardIteratorRequest& Aws::Kinesis::Model::GetShardIteratorRequest::WithTimestamp ( Aws::Utils::DateTime &&  value )

inline

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Definition at line 355 of file GetShardIteratorRequest.h.

---

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

• aws-cpp-sdk-kinesis/include/aws/kinesis/model/GetShardIteratorRequest.h