/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Kinesis { namespace Model { /** *

Represents the input for GetRecords.

See Also:

AWS * API Reference

*/ class GetRecordsRequest : public KinesisRequest { public: AWS_KINESIS_API GetRecordsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetRecords"; } AWS_KINESIS_API Aws::String SerializePayload() const override; AWS_KINESIS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_KINESIS_API EndpointParameters GetEndpointContextParams() const override; /** *

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.

*/ inline const Aws::String& GetShardIterator() const{ return m_shardIterator; } /** *

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.

*/ inline bool ShardIteratorHasBeenSet() const { return m_shardIteratorHasBeenSet; } /** *

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.

*/ inline void SetShardIterator(const Aws::String& value) { m_shardIteratorHasBeenSet = true; m_shardIterator = value; } /** *

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.

*/ inline void SetShardIterator(Aws::String&& value) { m_shardIteratorHasBeenSet = true; m_shardIterator = std::move(value); } /** *

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.

*/ inline void SetShardIterator(const char* value) { m_shardIteratorHasBeenSet = true; m_shardIterator.assign(value); } /** *

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.

*/ inline GetRecordsRequest& WithShardIterator(const Aws::String& value) { SetShardIterator(value); return *this;} /** *

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.

*/ inline GetRecordsRequest& WithShardIterator(Aws::String&& value) { SetShardIterator(std::move(value)); return *this;} /** *

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.

*/ inline GetRecordsRequest& WithShardIterator(const char* value) { SetShardIterator(value); return *this;} /** *

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.

*/ inline int GetLimit() const{ return m_limit; } /** *

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.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

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.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

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.

*/ inline GetRecordsRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

The ARN of the stream.

*/ inline const Aws::String& GetStreamARN() const{ return m_streamARN; } /** *

The ARN of the stream.

*/ inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; } /** *

The ARN of the stream.

*/ inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; } /** *

The ARN of the stream.

*/ inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); } /** *

The ARN of the stream.

*/ inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); } /** *

The ARN of the stream.

*/ inline GetRecordsRequest& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;} /** *

The ARN of the stream.

*/ inline GetRecordsRequest& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;} /** *

The ARN of the stream.

*/ inline GetRecordsRequest& WithStreamARN(const char* value) { SetStreamARN(value); return *this;} private: Aws::String m_shardIterator; bool m_shardIteratorHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_streamARN; bool m_streamARNHasBeenSet = false; }; } // namespace Model } // namespace Kinesis } // namespace Aws