AWS SDK for C++  1.9.103
AWS SDK for C++
GetShardIteratorRequest.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Kinesis
17 {
18 namespace Model
19 {
20 
28  {
29  public:
31 
32  // Service request name is the Operation name which will send this request out,
33  // each operation should has unique request name, so that we can get operation's name from this request.
34  // Note: this is not true for response, multiple operations may have the same response name,
35  // so we can not get operation's name from response.
36  inline virtual const char* GetServiceRequestName() const override { return "GetShardIterator"; }
37 
38  Aws::String SerializePayload() const override;
39 
41 
42 
46  inline const Aws::String& GetStreamName() const{ return m_streamName; }
47 
51  inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
52 
56  inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
57 
61  inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
62 
66  inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
67 
71  inline GetShardIteratorRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
72 
76  inline GetShardIteratorRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
77 
81  inline GetShardIteratorRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;}
82 
83 
87  inline const Aws::String& GetShardId() const{ return m_shardId; }
88 
92  inline bool ShardIdHasBeenSet() const { return m_shardIdHasBeenSet; }
93 
97  inline void SetShardId(const Aws::String& value) { m_shardIdHasBeenSet = true; m_shardId = value; }
98 
102  inline void SetShardId(Aws::String&& value) { m_shardIdHasBeenSet = true; m_shardId = std::move(value); }
103 
107  inline void SetShardId(const char* value) { m_shardIdHasBeenSet = true; m_shardId.assign(value); }
108 
112  inline GetShardIteratorRequest& WithShardId(const Aws::String& value) { SetShardId(value); return *this;}
113 
117  inline GetShardIteratorRequest& WithShardId(Aws::String&& value) { SetShardId(std::move(value)); return *this;}
118 
122  inline GetShardIteratorRequest& WithShardId(const char* value) { SetShardId(value); return *this;}
123 
124 
140  inline const ShardIteratorType& GetShardIteratorType() const{ return m_shardIteratorType; }
141 
157  inline bool ShardIteratorTypeHasBeenSet() const { return m_shardIteratorTypeHasBeenSet; }
158 
174  inline void SetShardIteratorType(const ShardIteratorType& value) { m_shardIteratorTypeHasBeenSet = true; m_shardIteratorType = value; }
175 
191  inline void SetShardIteratorType(ShardIteratorType&& value) { m_shardIteratorTypeHasBeenSet = true; m_shardIteratorType = std::move(value); }
192 
208  inline GetShardIteratorRequest& WithShardIteratorType(const ShardIteratorType& value) { SetShardIteratorType(value); return *this;}
209 
225  inline GetShardIteratorRequest& WithShardIteratorType(ShardIteratorType&& value) { SetShardIteratorType(std::move(value)); return *this;}
226 
227 
233  inline const Aws::String& GetStartingSequenceNumber() const{ return m_startingSequenceNumber; }
234 
240  inline bool StartingSequenceNumberHasBeenSet() const { return m_startingSequenceNumberHasBeenSet; }
241 
247  inline void SetStartingSequenceNumber(const Aws::String& value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber = value; }
248 
254  inline void SetStartingSequenceNumber(Aws::String&& value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber = std::move(value); }
255 
261  inline void SetStartingSequenceNumber(const char* value) { m_startingSequenceNumberHasBeenSet = true; m_startingSequenceNumber.assign(value); }
262 
268  inline GetShardIteratorRequest& WithStartingSequenceNumber(const Aws::String& value) { SetStartingSequenceNumber(value); return *this;}
269 
275  inline GetShardIteratorRequest& WithStartingSequenceNumber(Aws::String&& value) { SetStartingSequenceNumber(std::move(value)); return *this;}
276 
282  inline GetShardIteratorRequest& WithStartingSequenceNumber(const char* value) { SetStartingSequenceNumber(value); return *this;}
283 
284 
295  inline const Aws::Utils::DateTime& GetTimestamp() const{ return m_timestamp; }
296 
307  inline bool TimestampHasBeenSet() const { return m_timestampHasBeenSet; }
308 
319  inline void SetTimestamp(const Aws::Utils::DateTime& value) { m_timestampHasBeenSet = true; m_timestamp = value; }
320 
331  inline void SetTimestamp(Aws::Utils::DateTime&& value) { m_timestampHasBeenSet = true; m_timestamp = std::move(value); }
332 
343  inline GetShardIteratorRequest& WithTimestamp(const Aws::Utils::DateTime& value) { SetTimestamp(value); return *this;}
344 
355  inline GetShardIteratorRequest& WithTimestamp(Aws::Utils::DateTime&& value) { SetTimestamp(std::move(value)); return *this;}
356 
357  private:
358 
359  Aws::String m_streamName;
360  bool m_streamNameHasBeenSet;
361 
362  Aws::String m_shardId;
363  bool m_shardIdHasBeenSet;
364 
365  ShardIteratorType m_shardIteratorType;
366  bool m_shardIteratorTypeHasBeenSet;
367 
368  Aws::String m_startingSequenceNumber;
369  bool m_startingSequenceNumberHasBeenSet;
370 
371  Aws::Utils::DateTime m_timestamp;
372  bool m_timestampHasBeenSet;
373  };
374 
375 } // namespace Model
376 } // namespace Kinesis
377 } // namespace Aws
Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId
GetShardIteratorRequest & WithShardId(const Aws::String &value)
Definition: GetShardIteratorRequest.h:112
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName
void SetStreamName(const Aws::String &value)
Definition: GetShardIteratorRequest.h:56
Aws::Kinesis::Model::GetShardIteratorRequest::WithTimestamp
GetShardIteratorRequest & WithTimestamp(Aws::Utils::DateTime &&value)
Definition: GetShardIteratorRequest.h:355
Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber
GetShardIteratorRequest & WithStartingSequenceNumber(const Aws::String &value)
Definition: GetShardIteratorRequest.h:268
Aws::Kinesis::Model::GetShardIteratorRequest::SetTimestamp
void SetTimestamp(Aws::Utils::DateTime &&value)
Definition: GetShardIteratorRequest.h:331
Aws::Kinesis::Model::GetShardIteratorRequest::WithShardIteratorType
GetShardIteratorRequest & WithShardIteratorType(ShardIteratorType &&value)
Definition: GetShardIteratorRequest.h:225
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Kinesis::Model::GetShardIteratorRequest::SetShardIteratorType
void SetShardIteratorType(const ShardIteratorType &value)
Definition: GetShardIteratorRequest.h:174
Aws::Kinesis::Model::GetShardIteratorRequest::SetTimestamp
void SetTimestamp(const Aws::Utils::DateTime &value)
Definition: GetShardIteratorRequest.h:319
Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId
GetShardIteratorRequest & WithShardId(Aws::String &&value)
Definition: GetShardIteratorRequest.h:117
ShardIteratorType.h
DateTime.h
Aws::Kinesis::Model::GetShardIteratorRequest::ShardIteratorTypeHasBeenSet
bool ShardIteratorTypeHasBeenSet() const
Definition: GetShardIteratorRequest.h:157
Aws::Kinesis::Model::GetShardIteratorRequest::StreamNameHasBeenSet
bool StreamNameHasBeenSet() const
Definition: GetShardIteratorRequest.h:51
Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber
void SetStartingSequenceNumber(Aws::String &&value)
Definition: GetShardIteratorRequest.h:254
Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName
GetShardIteratorRequest & WithStreamName(Aws::String &&value)
Definition: GetShardIteratorRequest.h:76
Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber
GetShardIteratorRequest & WithStartingSequenceNumber(Aws::String &&value)
Definition: GetShardIteratorRequest.h:275
Aws::Kinesis::Model::GetShardIteratorRequest
Definition: GetShardIteratorRequest.h:28
Aws::Kinesis::Model::GetShardIteratorRequest::WithStartingSequenceNumber
GetShardIteratorRequest & WithStartingSequenceNumber(const char *value)
Definition: GetShardIteratorRequest.h:282
Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId
void SetShardId(const Aws::String &value)
Definition: GetShardIteratorRequest.h:97
AWS_KINESIS_API
#define AWS_KINESIS_API
Definition: Kinesis_EXPORTS.h:28
Aws::Kinesis::Model::GetShardIteratorRequest::GetStreamName
const Aws::String & GetStreamName() const
Definition: GetShardIteratorRequest.h:46
Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName
GetShardIteratorRequest & WithStreamName(const Aws::String &value)
Definition: GetShardIteratorRequest.h:71
Aws::Kinesis::Model::GetShardIteratorRequest::WithShardId
GetShardIteratorRequest & WithShardId(const char *value)
Definition: GetShardIteratorRequest.h:122
Aws::Kinesis::Model::GetShardIteratorRequest::SetShardIteratorType
void SetShardIteratorType(ShardIteratorType &&value)
Definition: GetShardIteratorRequest.h:191
Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId
void SetShardId(const char *value)
Definition: GetShardIteratorRequest.h:107
Aws::Kinesis::Model::GetShardIteratorRequest::ShardIdHasBeenSet
bool ShardIdHasBeenSet() const
Definition: GetShardIteratorRequest.h:92
KinesisRequest.h
Aws::Kinesis::Model::GetShardIteratorRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Kinesis::Model::GetShardIteratorRequest::GetTimestamp
const Aws::Utils::DateTime & GetTimestamp() const
Definition: GetShardIteratorRequest.h:295
Aws::Kinesis::Model::GetShardIteratorRequest::GetStartingSequenceNumber
const Aws::String & GetStartingSequenceNumber() const
Definition: GetShardIteratorRequest.h:233
Aws::Kinesis::Model::GetShardIteratorRequest::TimestampHasBeenSet
bool TimestampHasBeenSet() const
Definition: GetShardIteratorRequest.h:307
Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber
void SetStartingSequenceNumber(const char *value)
Definition: GetShardIteratorRequest.h:261
Aws::Kinesis::Model::GetShardIteratorRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: GetShardIteratorRequest.h:36
Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName
void SetStreamName(const char *value)
Definition: GetShardIteratorRequest.h:66
Aws::Kinesis::Model::GetShardIteratorRequest::GetShardIteratorType
const ShardIteratorType & GetShardIteratorType() const
Definition: GetShardIteratorRequest.h:140
AWSString.h
Aws::Kinesis::KinesisRequest
Definition: KinesisRequest.h:17
Aws::Kinesis::Model::GetShardIteratorRequest::GetShardId
const Aws::String & GetShardId() const
Definition: GetShardIteratorRequest.h:87
Aws::Kinesis::Model::GetShardIteratorRequest::WithShardIteratorType
GetShardIteratorRequest & WithShardIteratorType(const ShardIteratorType &value)
Definition: GetShardIteratorRequest.h:208
Aws::Kinesis::Model::GetShardIteratorRequest::WithTimestamp
GetShardIteratorRequest & WithTimestamp(const Aws::Utils::DateTime &value)
Definition: GetShardIteratorRequest.h:343
Aws::Kinesis::Model::GetShardIteratorRequest::SetShardId
void SetShardId(Aws::String &&value)
Definition: GetShardIteratorRequest.h:102
Aws::Kinesis::Model::GetShardIteratorRequest::StartingSequenceNumberHasBeenSet
bool StartingSequenceNumberHasBeenSet() const
Definition: GetShardIteratorRequest.h:240
Kinesis_EXPORTS.h
Aws::Kinesis::Model::GetShardIteratorRequest::WithStreamName
GetShardIteratorRequest & WithStreamName(const char *value)
Definition: GetShardIteratorRequest.h:81
Aws
Definition: AccessManagementClient.h:15
Aws::Kinesis::Model::GetShardIteratorRequest::GetShardIteratorRequest
GetShardIteratorRequest()
Aws::Kinesis::Model::GetShardIteratorRequest::SetStartingSequenceNumber
void SetStartingSequenceNumber(const Aws::String &value)
Definition: GetShardIteratorRequest.h:247
Aws::Kinesis::Model::ShardIteratorType
ShardIteratorType
Definition: ShardIteratorType.h:17
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Kinesis::Model::GetShardIteratorRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::Kinesis::Model::GetShardIteratorRequest::SetStreamName
void SetStreamName(Aws::String &&value)
Definition: GetShardIteratorRequest.h:61