AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDBStreams::Model::GetShardIteratorRequest Class Reference

#include <GetShardIteratorRequest.h>

+ Inheritance diagram for Aws::DynamoDBStreams::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::StringGetStreamArn () const
 
bool StreamArnHasBeenSet () const
 
void SetStreamArn (const Aws::String &value)
 
void SetStreamArn (Aws::String &&value)
 
void SetStreamArn (const char *value)
 
GetShardIteratorRequestWithStreamArn (const Aws::String &value)
 
GetShardIteratorRequestWithStreamArn (Aws::String &&value)
 
GetShardIteratorRequestWithStreamArn (const char *value)
 
const Aws::StringGetShardId () const
 
bool ShardIdHasBeenSet () const
 
void SetShardId (const Aws::String &value)
 
void SetShardId (Aws::String &&value)
 
void SetShardId (const char *value)
 
GetShardIteratorRequestWithShardId (const Aws::String &value)
 
GetShardIteratorRequestWithShardId (Aws::String &&value)
 
GetShardIteratorRequestWithShardId (const char *value)
 
const ShardIteratorTypeGetShardIteratorType () const
 
bool ShardIteratorTypeHasBeenSet () const
 
void SetShardIteratorType (const ShardIteratorType &value)
 
void SetShardIteratorType (ShardIteratorType &&value)
 
GetShardIteratorRequestWithShardIteratorType (const ShardIteratorType &value)
 
GetShardIteratorRequestWithShardIteratorType (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)
 
GetShardIteratorRequestWithSequenceNumber (const Aws::String &value)
 
GetShardIteratorRequestWithSequenceNumber (Aws::String &&value)
 
GetShardIteratorRequestWithSequenceNumber (const char *value)
 
- Public Member Functions inherited from Aws::DynamoDBStreams::DynamoDBStreamsRequest
virtual ~DynamoDBStreamsRequest ()
 
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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 of a GetShardIterator operation.

See Also:

AWS API Reference

Definition at line 26 of file GetShardIteratorRequest.h.

Constructor & Destructor Documentation

◆ GetShardIteratorRequest()

Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetShardIteratorRequest ( )

Member Function Documentation

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSequenceNumber()

const Aws::String& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetSequenceNumber ( ) const
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 227 of file GetShardIteratorRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetShardIteratorRequest.h.

◆ GetShardId()

const Aws::String& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetShardId ( ) const
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 87 of file GetShardIteratorRequest.h.

◆ GetShardIteratorType()

const ShardIteratorType& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetShardIteratorType ( ) const
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 145 of file GetShardIteratorRequest.h.

◆ GetStreamArn()

const Aws::String& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::GetStreamArn ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 45 of file GetShardIteratorRequest.h.

◆ SequenceNumberHasBeenSet()

bool Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SequenceNumberHasBeenSet ( ) const
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 233 of file GetShardIteratorRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetSequenceNumber() [1/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetSequenceNumber ( const Aws::String value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 239 of file GetShardIteratorRequest.h.

◆ SetSequenceNumber() [2/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetSequenceNumber ( Aws::String &&  value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 245 of file GetShardIteratorRequest.h.

◆ SetSequenceNumber() [3/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetSequenceNumber ( const char *  value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 251 of file GetShardIteratorRequest.h.

◆ SetShardId() [1/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetShardId ( const Aws::String value)
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 99 of file GetShardIteratorRequest.h.

◆ SetShardId() [2/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetShardId ( Aws::String &&  value)
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 105 of file GetShardIteratorRequest.h.

◆ SetShardId() [3/3]

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

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 111 of file GetShardIteratorRequest.h.

◆ SetShardIteratorType() [1/2]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetShardIteratorType ( const ShardIteratorType value)
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 175 of file GetShardIteratorRequest.h.

◆ SetShardIteratorType() [2/2]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetShardIteratorType ( ShardIteratorType &&  value)
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 190 of file GetShardIteratorRequest.h.

◆ SetStreamArn() [1/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 55 of file GetShardIteratorRequest.h.

◆ SetStreamArn() [2/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 60 of file GetShardIteratorRequest.h.

◆ SetStreamArn() [3/3]

void Aws::DynamoDBStreams::Model::GetShardIteratorRequest::SetStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 65 of file GetShardIteratorRequest.h.

◆ ShardIdHasBeenSet()

bool Aws::DynamoDBStreams::Model::GetShardIteratorRequest::ShardIdHasBeenSet ( ) const
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 93 of file GetShardIteratorRequest.h.

◆ ShardIteratorTypeHasBeenSet()

bool Aws::DynamoDBStreams::Model::GetShardIteratorRequest::ShardIteratorTypeHasBeenSet ( ) const
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 160 of file GetShardIteratorRequest.h.

◆ StreamArnHasBeenSet()

bool Aws::DynamoDBStreams::Model::GetShardIteratorRequest::StreamArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 50 of file GetShardIteratorRequest.h.

◆ WithSequenceNumber() [1/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithSequenceNumber ( const Aws::String value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 257 of file GetShardIteratorRequest.h.

◆ WithSequenceNumber() [2/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithSequenceNumber ( Aws::String &&  value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 263 of file GetShardIteratorRequest.h.

◆ WithSequenceNumber() [3/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithSequenceNumber ( const char *  value)
inline

The sequence number of a stream record in the shard from which to start reading.

Definition at line 269 of file GetShardIteratorRequest.h.

◆ WithShardId() [1/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithShardId ( const Aws::String value)
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 117 of file GetShardIteratorRequest.h.

◆ WithShardId() [2/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithShardId ( Aws::String &&  value)
inline

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 123 of file GetShardIteratorRequest.h.

◆ WithShardId() [3/3]

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

The identifier of the shard. The iterator will be returned for this shard ID.

Definition at line 129 of file GetShardIteratorRequest.h.

◆ WithShardIteratorType() [1/2]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithShardIteratorType ( const ShardIteratorType value)
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 205 of file GetShardIteratorRequest.h.

◆ WithShardIteratorType() [2/2]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithShardIteratorType ( ShardIteratorType &&  value)
inline

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

Definition at line 220 of file GetShardIteratorRequest.h.

◆ WithStreamArn() [1/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 70 of file GetShardIteratorRequest.h.

◆ WithStreamArn() [2/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 75 of file GetShardIteratorRequest.h.

◆ WithStreamArn() [3/3]

GetShardIteratorRequest& Aws::DynamoDBStreams::Model::GetShardIteratorRequest::WithStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 80 of file GetShardIteratorRequest.h.


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