#include <GetRecordsRequest.h>
Represents the input for GetRecords.
See Also:
AWS API Reference
Definition at line 24 of file GetRecordsRequest.h.
◆ GetRecordsRequest()
Aws::Kinesis::Model::GetRecordsRequest::GetRecordsRequest |
( |
| ) |
|
◆ 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()
◆ GetServiceRequestName()
virtual const char* Aws::Kinesis::Model::GetRecordsRequest::GetServiceRequestName |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ 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 |
◆ 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()
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]
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]
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: