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

#include <GetRecordsRequest.h>

+ Inheritance diagram for Aws::Kinesis::Model::GetRecordsRequest:

Public Member Functions

 GetRecordsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::String & GetShardIterator () const
 
bool ShardIteratorHasBeenSet () const
 
void SetShardIterator (const Aws::String &value)
 
void SetShardIterator (Aws::String &&value)
 
void SetShardIterator (const char *value)
 
GetRecordsRequest & WithShardIterator (const Aws::String &value)
 
GetRecordsRequest & WithShardIterator (Aws::String &&value)
 
GetRecordsRequest & WithShardIterator (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetRecordsRequest & WithLimit (int 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 GetRecords.

See Also:

AWS API Reference

Definition at line 24 of file GetRecordsRequest.h.

Constructor & Destructor Documentation

◆ GetRecordsRequest()

Aws::Kinesis::Model::GetRecordsRequest::GetRecordsRequest ( )

Member Function Documentation

◆ GetLimit()

int Aws::Kinesis::Model::GetRecordsRequest::GetLimit ( ) const
inline

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Definition at line 102 of file GetRecordsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::GetRecordsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::GetRecordsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file GetRecordsRequest.h.

◆ GetShardIterator()

const Aws::String& Aws::Kinesis::Model::GetRecordsRequest::GetShardIterator ( ) const
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 45 of file GetRecordsRequest.h.

◆ LimitHasBeenSet()

bool Aws::Kinesis::Model::GetRecordsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Definition at line 109 of file GetRecordsRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::GetRecordsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::Kinesis::Model::GetRecordsRequest::SetLimit ( int  value)
inline

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Definition at line 116 of file GetRecordsRequest.h.

◆ SetShardIterator() [1/3]

void Aws::Kinesis::Model::GetRecordsRequest::SetShardIterator ( Aws::String &&  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 66 of file GetRecordsRequest.h.

◆ SetShardIterator() [2/3]

void Aws::Kinesis::Model::GetRecordsRequest::SetShardIterator ( const Aws::String &  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 59 of file GetRecordsRequest.h.

◆ SetShardIterator() [3/3]

void Aws::Kinesis::Model::GetRecordsRequest::SetShardIterator ( const char *  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 73 of file GetRecordsRequest.h.

◆ ShardIteratorHasBeenSet()

bool Aws::Kinesis::Model::GetRecordsRequest::ShardIteratorHasBeenSet ( ) const
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 52 of file GetRecordsRequest.h.

◆ WithLimit()

GetRecordsRequest& Aws::Kinesis::Model::GetRecordsRequest::WithLimit ( int  value)
inline

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Definition at line 123 of file GetRecordsRequest.h.

◆ WithShardIterator() [1/3]

GetRecordsRequest& Aws::Kinesis::Model::GetRecordsRequest::WithShardIterator ( Aws::String &&  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 87 of file GetRecordsRequest.h.

◆ WithShardIterator() [2/3]

GetRecordsRequest& Aws::Kinesis::Model::GetRecordsRequest::WithShardIterator ( const Aws::String &  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 80 of file GetRecordsRequest.h.

◆ WithShardIterator() [3/3]

GetRecordsRequest& Aws::Kinesis::Model::GetRecordsRequest::WithShardIterator ( const char *  value)
inline

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Definition at line 94 of file GetRecordsRequest.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.19
Privacy | Site terms | Cookie preferences