AWS SDK for C++  1.9.104
AWS SDK for C++
ListShardsRequest.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 
24  {
25  public:
27 
28  // Service request name is the Operation name which will send this request out,
29  // each operation should has unique request name, so that we can get operation's name from this request.
30  // Note: this is not true for response, multiple operations may have the same response name,
31  // so we can not get operation's name from response.
32  inline virtual const char* GetServiceRequestName() const override { return "ListShards"; }
33 
34  Aws::String SerializePayload() const override;
35 
37 
38 
43  inline const Aws::String& GetStreamName() const{ return m_streamName; }
44 
49  inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
50 
55  inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
56 
61  inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
62 
67  inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
68 
73  inline ListShardsRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
74 
79  inline ListShardsRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
80 
85  inline ListShardsRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;}
86 
87 
109  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
110 
132  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
133 
155  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
156 
178  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
179 
201  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
202 
224  inline ListShardsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
225 
247  inline ListShardsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
248 
270  inline ListShardsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
271 
272 
281  inline const Aws::String& GetExclusiveStartShardId() const{ return m_exclusiveStartShardId; }
282 
291  inline bool ExclusiveStartShardIdHasBeenSet() const { return m_exclusiveStartShardIdHasBeenSet; }
292 
301  inline void SetExclusiveStartShardId(const Aws::String& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = value; }
302 
311  inline void SetExclusiveStartShardId(Aws::String&& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = std::move(value); }
312 
321  inline void SetExclusiveStartShardId(const char* value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId.assign(value); }
322 
331  inline ListShardsRequest& WithExclusiveStartShardId(const Aws::String& value) { SetExclusiveStartShardId(value); return *this;}
332 
341  inline ListShardsRequest& WithExclusiveStartShardId(Aws::String&& value) { SetExclusiveStartShardId(std::move(value)); return *this;}
342 
351  inline ListShardsRequest& WithExclusiveStartShardId(const char* value) { SetExclusiveStartShardId(value); return *this;}
352 
353 
362  inline int GetMaxResults() const{ return m_maxResults; }
363 
372  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
373 
382  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
383 
392  inline ListShardsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
393 
394 
403  inline const Aws::Utils::DateTime& GetStreamCreationTimestamp() const{ return m_streamCreationTimestamp; }
404 
413  inline bool StreamCreationTimestampHasBeenSet() const { return m_streamCreationTimestampHasBeenSet; }
414 
423  inline void SetStreamCreationTimestamp(const Aws::Utils::DateTime& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = value; }
424 
433  inline void SetStreamCreationTimestamp(Aws::Utils::DateTime&& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = std::move(value); }
434 
443  inline ListShardsRequest& WithStreamCreationTimestamp(const Aws::Utils::DateTime& value) { SetStreamCreationTimestamp(value); return *this;}
444 
453  inline ListShardsRequest& WithStreamCreationTimestamp(Aws::Utils::DateTime&& value) { SetStreamCreationTimestamp(std::move(value)); return *this;}
454 
455 
456 
457  inline const ShardFilter& GetShardFilter() const{ return m_shardFilter; }
458 
459 
460  inline bool ShardFilterHasBeenSet() const { return m_shardFilterHasBeenSet; }
461 
462 
463  inline void SetShardFilter(const ShardFilter& value) { m_shardFilterHasBeenSet = true; m_shardFilter = value; }
464 
465 
466  inline void SetShardFilter(ShardFilter&& value) { m_shardFilterHasBeenSet = true; m_shardFilter = std::move(value); }
467 
468 
469  inline ListShardsRequest& WithShardFilter(const ShardFilter& value) { SetShardFilter(value); return *this;}
470 
471 
472  inline ListShardsRequest& WithShardFilter(ShardFilter&& value) { SetShardFilter(std::move(value)); return *this;}
473 
474  private:
475 
476  Aws::String m_streamName;
477  bool m_streamNameHasBeenSet;
478 
479  Aws::String m_nextToken;
480  bool m_nextTokenHasBeenSet;
481 
482  Aws::String m_exclusiveStartShardId;
483  bool m_exclusiveStartShardIdHasBeenSet;
484 
485  int m_maxResults;
486  bool m_maxResultsHasBeenSet;
487 
488  Aws::Utils::DateTime m_streamCreationTimestamp;
489  bool m_streamCreationTimestampHasBeenSet;
490 
491  ShardFilter m_shardFilter;
492  bool m_shardFilterHasBeenSet;
493  };
494 
495 } // namespace Model
496 } // namespace Kinesis
497 } // namespace Aws
Aws::Kinesis::Model::ShardFilter
Definition: ShardFilter.h:29
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::Kinesis::Model::ListShardsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: ListShardsRequest.h:132
Aws::Kinesis::Model::ListShardsRequest::ShardFilterHasBeenSet
bool ShardFilterHasBeenSet() const
Definition: ListShardsRequest.h:460
Aws::Kinesis::Model::ListShardsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: ListShardsRequest.h:109
Aws::Kinesis::Model::ListShardsRequest::SetMaxResults
void SetMaxResults(int value)
Definition: ListShardsRequest.h:382
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Kinesis::Model::ListShardsRequest::WithStreamCreationTimestamp
ListShardsRequest & WithStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: ListShardsRequest.h:443
Aws::Kinesis::Model::ListShardsRequest
Definition: ListShardsRequest.h:24
Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(const char *value)
Definition: ListShardsRequest.h:321
Aws::Kinesis::Model::ListShardsRequest::GetMaxResults
int GetMaxResults() const
Definition: ListShardsRequest.h:362
DateTime.h
Aws::Kinesis::Model::ListShardsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListShardsRequest.h:32
Aws::Kinesis::Model::ListShardsRequest::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: ListShardsRequest.h:423
Aws::Kinesis::Model::ListShardsRequest::ListShardsRequest
ListShardsRequest()
Aws::Kinesis::Model::ListShardsRequest::WithStreamCreationTimestamp
ListShardsRequest & WithStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: ListShardsRequest.h:453
Aws::Kinesis::Model::ListShardsRequest::SetStreamName
void SetStreamName(const char *value)
Definition: ListShardsRequest.h:67
AWS_KINESIS_API
#define AWS_KINESIS_API
Definition: Kinesis_EXPORTS.h:28
Aws::Kinesis::Model::ListShardsRequest::StreamCreationTimestampHasBeenSet
bool StreamCreationTimestampHasBeenSet() const
Definition: ListShardsRequest.h:413
Aws::Kinesis::Model::ListShardsRequest::SetShardFilter
void SetShardFilter(ShardFilter &&value)
Definition: ListShardsRequest.h:466
Aws::Kinesis::Model::ListShardsRequest::WithStreamName
ListShardsRequest & WithStreamName(const Aws::String &value)
Definition: ListShardsRequest.h:73
Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(const Aws::String &value)
Definition: ListShardsRequest.h:301
KinesisRequest.h
Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId
ListShardsRequest & WithExclusiveStartShardId(const char *value)
Definition: ListShardsRequest.h:351
Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(Aws::String &&value)
Definition: ListShardsRequest.h:311
Aws::Kinesis::Model::ListShardsRequest::GetStreamName
const Aws::String & GetStreamName() const
Definition: ListShardsRequest.h:43
Aws::Kinesis::Model::ListShardsRequest::StreamNameHasBeenSet
bool StreamNameHasBeenSet() const
Definition: ListShardsRequest.h:49
Aws::Kinesis::Model::ListShardsRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: ListShardsRequest.h:372
Aws::Kinesis::Model::ListShardsRequest::GetExclusiveStartShardId
const Aws::String & GetExclusiveStartShardId() const
Definition: ListShardsRequest.h:281
Aws::Kinesis::Model::ListShardsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Kinesis::Model::ListShardsRequest::WithShardFilter
ListShardsRequest & WithShardFilter(const ShardFilter &value)
Definition: ListShardsRequest.h:469
Aws::Kinesis::Model::ListShardsRequest::WithNextToken
ListShardsRequest & WithNextToken(const char *value)
Definition: ListShardsRequest.h:270
Aws::Kinesis::Model::ListShardsRequest::SetShardFilter
void SetShardFilter(const ShardFilter &value)
Definition: ListShardsRequest.h:463
Aws::Kinesis::Model::ListShardsRequest::SetStreamName
void SetStreamName(const Aws::String &value)
Definition: ListShardsRequest.h:55
AWSString.h
Aws::Kinesis::KinesisRequest
Definition: KinesisRequest.h:17
Aws::Kinesis::Model::ListShardsRequest::ExclusiveStartShardIdHasBeenSet
bool ExclusiveStartShardIdHasBeenSet() const
Definition: ListShardsRequest.h:291
Aws::Kinesis::Model::ListShardsRequest::GetShardFilter
const ShardFilter & GetShardFilter() const
Definition: ListShardsRequest.h:457
Kinesis_EXPORTS.h
Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId
ListShardsRequest & WithExclusiveStartShardId(const Aws::String &value)
Definition: ListShardsRequest.h:331
Aws::Kinesis::Model::ListShardsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: ListShardsRequest.h:201
Aws::Kinesis::Model::ListShardsRequest::WithNextToken
ListShardsRequest & WithNextToken(const Aws::String &value)
Definition: ListShardsRequest.h:224
Aws::Kinesis::Model::ListShardsRequest::WithMaxResults
ListShardsRequest & WithMaxResults(int value)
Definition: ListShardsRequest.h:392
Aws::Kinesis::Model::ListShardsRequest::WithStreamName
ListShardsRequest & WithStreamName(Aws::String &&value)
Definition: ListShardsRequest.h:79
Aws
Definition: AccessManagementClient.h:15
Aws::Kinesis::Model::ListShardsRequest::WithShardFilter
ListShardsRequest & WithShardFilter(ShardFilter &&value)
Definition: ListShardsRequest.h:472
Aws::Kinesis::Model::ListShardsRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Kinesis::Model::ListShardsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: ListShardsRequest.h:155
Aws::Kinesis::Model::ListShardsRequest::WithStreamName
ListShardsRequest & WithStreamName(const char *value)
Definition: ListShardsRequest.h:85
Aws::Kinesis::Model::ListShardsRequest::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: ListShardsRequest.h:433
Aws::Kinesis::Model::ListShardsRequest::WithNextToken
ListShardsRequest & WithNextToken(Aws::String &&value)
Definition: ListShardsRequest.h:247
Aws::Kinesis::Model::ListShardsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: ListShardsRequest.h:178
ShardFilter.h
Aws::Kinesis::Model::ListShardsRequest::GetStreamCreationTimestamp
const Aws::Utils::DateTime & GetStreamCreationTimestamp() const
Definition: ListShardsRequest.h:403
Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId
ListShardsRequest & WithExclusiveStartShardId(Aws::String &&value)
Definition: ListShardsRequest.h:341
Aws::Kinesis::Model::ListShardsRequest::SetStreamName
void SetStreamName(Aws::String &&value)
Definition: ListShardsRequest.h:61