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

Represents the input for GetShardIterator.

See * Also:

AWS * API Reference

*/ class AWS_KINESIS_API GetShardIteratorRequest : public KinesisRequest { public: GetShardIteratorRequest(); // 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 "GetShardIterator"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the Amazon Kinesis data stream.

*/ inline const Aws::String& GetStreamName() const{ return m_streamName; } /** *

The name of the Amazon Kinesis data stream.

*/ inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; } /** *

The name of the Amazon Kinesis data stream.

*/ inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; } /** *

The name of the Amazon Kinesis data stream.

*/ inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); } /** *

The name of the Amazon Kinesis data stream.

*/ inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); } /** *

The name of the Amazon Kinesis data stream.

*/ inline GetShardIteratorRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;} /** *

The name of the Amazon Kinesis data stream.

*/ inline GetShardIteratorRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;} /** *

The name of the Amazon Kinesis data stream.

*/ inline GetShardIteratorRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;} /** *

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

*/ inline const Aws::String& GetShardId() const{ return m_shardId; } /** *

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

*/ inline bool ShardIdHasBeenSet() const { return m_shardIdHasBeenSet; } /** *

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

*/ inline void SetShardId(const Aws::String& value) { m_shardIdHasBeenSet = true; m_shardId = value; } /** *

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

*/ inline void SetShardId(Aws::String&& value) { m_shardIdHasBeenSet = true; m_shardId = std::move(value); } /** *

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

*/ inline void SetShardId(const char* value) { m_shardIdHasBeenSet = true; m_shardId.assign(value); } /** *

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

*/ inline GetShardIteratorRequest& WithShardId(const Aws::String& value) { SetShardId(value); return *this;} /** *

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

*/ inline GetShardIteratorRequest& WithShardId(Aws::String&& value) { SetShardId(std::move(value)); return *this;} /** *

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

*/ inline GetShardIteratorRequest& WithShardId(const char* value) { SetShardId(value); return *this;} /** *

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.

*/ inline const ShardIteratorType& GetShardIteratorType() const{ return m_shardIteratorType; } /** *

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.

*/ inline bool ShardIteratorTypeHasBeenSet() const { return m_shardIteratorTypeHasBeenSet; } /** *

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.

*/ inline void SetShardIteratorType(const ShardIteratorType& value) { m_shardIteratorTypeHasBeenSet = true; m_shardIteratorType = value; } /** *

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.

*/ inline void SetShardIteratorType(ShardIteratorType&& value) { m_shardIteratorTypeHasBeenSet = true; m_shardIteratorType = std::move(value); } /** *

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.

*/ inline GetShardIteratorRequest& WithShardIteratorType(const ShardIteratorType& value) { SetShardIteratorType(value); return *this;} /** *

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.

*/ inline GetShardIteratorRequest& WithShardIteratorType(ShardIteratorType&& value) { SetShardIteratorType(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetStartingSequenceNumber() const{ return m_startingSequenceNumber; } /** *

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.

*/ inline bool StartingSequenceNumberHasBeenSet() const { return m_startingSequenceNumberHasBeenSet; } /** *

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.

*/ inline void SetStartingSequenceNumber(const Aws::String& value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber = value; } /** *

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.

*/ inline void SetStartingSequenceNumber(Aws::String&& value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber = std::move(value); } /** *

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.

*/ inline void SetStartingSequenceNumber(const char* value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber.assign(value); } /** *

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.

*/ inline GetShardIteratorRequest& WithStartingSequenceNumber(const Aws::String& value) { SetStartingSequenceNumber(value); return *this;} /** *

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.

*/ inline GetShardIteratorRequest& WithStartingSequenceNumber(Aws::String&& value) { SetStartingSequenceNumber(std::move(value)); return *this;} /** *

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.

*/ inline GetShardIteratorRequest& WithStartingSequenceNumber(const char* value) { SetStartingSequenceNumber(value); return *this;} /** *

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).

*/ inline const Aws::Utils::DateTime& GetTimestamp() const{ return m_timestamp; } /** *

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).

*/ inline bool TimestampHasBeenSet() const { return m_timestampHasBeenSet; } /** *

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).

*/ inline void SetTimestamp(const Aws::Utils::DateTime& value) { m_timestampHasBeenSet = true; m_timestamp = value; } /** *

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).

*/ inline void SetTimestamp(Aws::Utils::DateTime&& value) { m_timestampHasBeenSet = true; m_timestamp = std::move(value); } /** *

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).

*/ inline GetShardIteratorRequest& WithTimestamp(const Aws::Utils::DateTime& value) { SetTimestamp(value); return *this;} /** *

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).

*/ inline GetShardIteratorRequest& WithTimestamp(Aws::Utils::DateTime&& value) { SetTimestamp(std::move(value)); return *this;} private: Aws::String m_streamName; bool m_streamNameHasBeenSet; Aws::String m_shardId; bool m_shardIdHasBeenSet; ShardIteratorType m_shardIteratorType; bool m_shardIteratorTypeHasBeenSet; Aws::String m_startingSequenceNumber; bool m_startingSequenceNumberHasBeenSet; Aws::Utils::DateTime m_timestamp; bool m_timestampHasBeenSet; }; } // namespace Model } // namespace Kinesis } // namespace Aws