AWS SDK for C++  1.9.103
AWS SDK for C++
StreamDescription.h
Go to the documentation of this file.
1 
6 #pragma once
15 #include <utility>
16 
17 namespace Aws
18 {
19 namespace Utils
20 {
21 namespace Json
22 {
23  class JsonValue;
24  class JsonView;
25 } // namespace Json
26 } // namespace Utils
27 namespace Kinesis
28 {
29 namespace Model
30 {
31 
39  {
40  public:
45 
46 
50  inline const Aws::String& GetStreamName() const{ return m_streamName; }
51 
55  inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
56 
60  inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
61 
65  inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
66 
70  inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
71 
75  inline StreamDescription& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
76 
80  inline StreamDescription& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
81 
85  inline StreamDescription& WithStreamName(const char* value) { SetStreamName(value); return *this;}
86 
87 
91  inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
92 
96  inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
97 
101  inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
102 
106  inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
107 
111  inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
112 
116  inline StreamDescription& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
117 
121  inline StreamDescription& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
122 
126  inline StreamDescription& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
127 
128 
143  inline const StreamStatus& GetStreamStatus() const{ return m_streamStatus; }
144 
159  inline bool StreamStatusHasBeenSet() const { return m_streamStatusHasBeenSet; }
160 
175  inline void SetStreamStatus(const StreamStatus& value) { m_streamStatusHasBeenSet = true; m_streamStatus = value; }
176 
191  inline void SetStreamStatus(StreamStatus&& value) { m_streamStatusHasBeenSet = true; m_streamStatus = std::move(value); }
192 
207  inline StreamDescription& WithStreamStatus(const StreamStatus& value) { SetStreamStatus(value); return *this;}
208 
223  inline StreamDescription& WithStreamStatus(StreamStatus&& value) { SetStreamStatus(std::move(value)); return *this;}
224 
225 
229  inline const Aws::Vector<Shard>& GetShards() const{ return m_shards; }
230 
234  inline bool ShardsHasBeenSet() const { return m_shardsHasBeenSet; }
235 
239  inline void SetShards(const Aws::Vector<Shard>& value) { m_shardsHasBeenSet = true; m_shards = value; }
240 
244  inline void SetShards(Aws::Vector<Shard>&& value) { m_shardsHasBeenSet = true; m_shards = std::move(value); }
245 
249  inline StreamDescription& WithShards(const Aws::Vector<Shard>& value) { SetShards(value); return *this;}
250 
254  inline StreamDescription& WithShards(Aws::Vector<Shard>&& value) { SetShards(std::move(value)); return *this;}
255 
259  inline StreamDescription& AddShards(const Shard& value) { m_shardsHasBeenSet = true; m_shards.push_back(value); return *this; }
260 
264  inline StreamDescription& AddShards(Shard&& value) { m_shardsHasBeenSet = true; m_shards.push_back(std::move(value)); return *this; }
265 
266 
271  inline bool GetHasMoreShards() const{ return m_hasMoreShards; }
272 
277  inline bool HasMoreShardsHasBeenSet() const { return m_hasMoreShardsHasBeenSet; }
278 
283  inline void SetHasMoreShards(bool value) { m_hasMoreShardsHasBeenSet = true; m_hasMoreShards = value; }
284 
289  inline StreamDescription& WithHasMoreShards(bool value) { SetHasMoreShards(value); return *this;}
290 
291 
296  inline int GetRetentionPeriodHours() const{ return m_retentionPeriodHours; }
297 
302  inline bool RetentionPeriodHoursHasBeenSet() const { return m_retentionPeriodHoursHasBeenSet; }
303 
308  inline void SetRetentionPeriodHours(int value) { m_retentionPeriodHoursHasBeenSet = true; m_retentionPeriodHours = value; }
309 
314  inline StreamDescription& WithRetentionPeriodHours(int value) { SetRetentionPeriodHours(value); return *this;}
315 
316 
320  inline const Aws::Utils::DateTime& GetStreamCreationTimestamp() const{ return m_streamCreationTimestamp; }
321 
325  inline bool StreamCreationTimestampHasBeenSet() const { return m_streamCreationTimestampHasBeenSet; }
326 
330  inline void SetStreamCreationTimestamp(const Aws::Utils::DateTime& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = value; }
331 
335  inline void SetStreamCreationTimestamp(Aws::Utils::DateTime&& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = std::move(value); }
336 
340  inline StreamDescription& WithStreamCreationTimestamp(const Aws::Utils::DateTime& value) { SetStreamCreationTimestamp(value); return *this;}
341 
345  inline StreamDescription& WithStreamCreationTimestamp(Aws::Utils::DateTime&& value) { SetStreamCreationTimestamp(std::move(value)); return *this;}
346 
347 
351  inline const Aws::Vector<EnhancedMetrics>& GetEnhancedMonitoring() const{ return m_enhancedMonitoring; }
352 
356  inline bool EnhancedMonitoringHasBeenSet() const { return m_enhancedMonitoringHasBeenSet; }
357 
361  inline void SetEnhancedMonitoring(const Aws::Vector<EnhancedMetrics>& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring = value; }
362 
366  inline void SetEnhancedMonitoring(Aws::Vector<EnhancedMetrics>&& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring = std::move(value); }
367 
371  inline StreamDescription& WithEnhancedMonitoring(const Aws::Vector<EnhancedMetrics>& value) { SetEnhancedMonitoring(value); return *this;}
372 
376  inline StreamDescription& WithEnhancedMonitoring(Aws::Vector<EnhancedMetrics>&& value) { SetEnhancedMonitoring(std::move(value)); return *this;}
377 
381  inline StreamDescription& AddEnhancedMonitoring(const EnhancedMetrics& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring.push_back(value); return *this; }
382 
386  inline StreamDescription& AddEnhancedMonitoring(EnhancedMetrics&& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring.push_back(std::move(value)); return *this; }
387 
388 
396  inline const EncryptionType& GetEncryptionType() const{ return m_encryptionType; }
397 
405  inline bool EncryptionTypeHasBeenSet() const { return m_encryptionTypeHasBeenSet; }
406 
414  inline void SetEncryptionType(const EncryptionType& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = value; }
415 
423  inline void SetEncryptionType(EncryptionType&& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = std::move(value); }
424 
432  inline StreamDescription& WithEncryptionType(const EncryptionType& value) { SetEncryptionType(value); return *this;}
433 
441  inline StreamDescription& WithEncryptionType(EncryptionType&& value) { SetEncryptionType(std::move(value)); return *this;}
442 
443 
458  inline const Aws::String& GetKeyId() const{ return m_keyId; }
459 
474  inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
475 
490  inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
491 
506  inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
507 
522  inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
523 
538  inline StreamDescription& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
539 
554  inline StreamDescription& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
555 
570  inline StreamDescription& WithKeyId(const char* value) { SetKeyId(value); return *this;}
571 
572  private:
573 
574  Aws::String m_streamName;
575  bool m_streamNameHasBeenSet;
576 
577  Aws::String m_streamARN;
578  bool m_streamARNHasBeenSet;
579 
580  StreamStatus m_streamStatus;
581  bool m_streamStatusHasBeenSet;
582 
583  Aws::Vector<Shard> m_shards;
584  bool m_shardsHasBeenSet;
585 
586  bool m_hasMoreShards;
587  bool m_hasMoreShardsHasBeenSet;
588 
589  int m_retentionPeriodHours;
590  bool m_retentionPeriodHoursHasBeenSet;
591 
592  Aws::Utils::DateTime m_streamCreationTimestamp;
593  bool m_streamCreationTimestampHasBeenSet;
594 
595  Aws::Vector<EnhancedMetrics> m_enhancedMonitoring;
596  bool m_enhancedMonitoringHasBeenSet;
597 
598  EncryptionType m_encryptionType;
599  bool m_encryptionTypeHasBeenSet;
600 
601  Aws::String m_keyId;
602  bool m_keyIdHasBeenSet;
603  };
604 
605 } // namespace Model
606 } // namespace Kinesis
607 } // namespace Aws
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::Kinesis::Model::StreamDescription::WithStreamStatus
StreamDescription & WithStreamStatus(const StreamStatus &value)
Definition: StreamDescription.h:207
Aws::Kinesis::Model::StreamStatus
StreamStatus
Definition: StreamStatus.h:17
Aws::Kinesis::Model::StreamDescription::AddEnhancedMonitoring
StreamDescription & AddEnhancedMonitoring(const EnhancedMetrics &value)
Definition: StreamDescription.h:381
Aws::Kinesis::Model::StreamDescription::operator=
StreamDescription & operator=(Aws::Utils::Json::JsonView jsonValue)
Aws::Kinesis::Model::StreamDescription::GetShards
const Aws::Vector< Shard > & GetShards() const
Definition: StreamDescription.h:229
Aws::Kinesis::Model::StreamDescription::RetentionPeriodHoursHasBeenSet
bool RetentionPeriodHoursHasBeenSet() const
Definition: StreamDescription.h:302
Aws::Kinesis::Model::StreamDescription::SetStreamName
void SetStreamName(const char *value)
Definition: StreamDescription.h:70
Aws::Kinesis::Model::StreamDescription::SetShards
void SetShards(const Aws::Vector< Shard > &value)
Definition: StreamDescription.h:239
Aws::Kinesis::Model::StreamDescription::StreamDescription
StreamDescription(Aws::Utils::Json::JsonView jsonValue)
Aws::Kinesis::Model::StreamDescription::SetShards
void SetShards(Aws::Vector< Shard > &&value)
Definition: StreamDescription.h:244
Aws::Kinesis::Model::StreamDescription::GetStreamName
const Aws::String & GetStreamName() const
Definition: StreamDescription.h:50
Aws::Kinesis::Model::StreamDescription::SetStreamARN
void SetStreamARN(const Aws::String &value)
Definition: StreamDescription.h:101
Aws::Kinesis::Model::StreamDescription::GetRetentionPeriodHours
int GetRetentionPeriodHours() const
Definition: StreamDescription.h:296
DateTime.h
Aws::Kinesis::Model::StreamDescription::StreamNameHasBeenSet
bool StreamNameHasBeenSet() const
Definition: StreamDescription.h:55
EnhancedMetrics.h
Aws::Kinesis::Model::StreamDescription::SetStreamARN
void SetStreamARN(Aws::String &&value)
Definition: StreamDescription.h:106
Aws::Kinesis::Model::StreamDescription::EnhancedMonitoringHasBeenSet
bool EnhancedMonitoringHasBeenSet() const
Definition: StreamDescription.h:356
Aws::Kinesis::Model::StreamDescription::Jsonize
Aws::Utils::Json::JsonValue Jsonize() const
Aws::Kinesis::Model::StreamDescription::SetKeyId
void SetKeyId(const char *value)
Definition: StreamDescription.h:522
Aws::Kinesis::Model::StreamDescription::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: StreamDescription.h:335
Aws::Kinesis::Model::StreamDescription::WithEncryptionType
StreamDescription & WithEncryptionType(const EncryptionType &value)
Definition: StreamDescription.h:432
EncryptionType.h
Aws::Kinesis::Model::StreamDescription::WithStreamARN
StreamDescription & WithStreamARN(const Aws::String &value)
Definition: StreamDescription.h:116
Aws::Kinesis::Model::StreamDescription::KeyIdHasBeenSet
bool KeyIdHasBeenSet() const
Definition: StreamDescription.h:474
Aws::Kinesis::Model::StreamDescription::WithKeyId
StreamDescription & WithKeyId(const char *value)
Definition: StreamDescription.h:570
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::Kinesis::Model::StreamDescription::SetKeyId
void SetKeyId(const Aws::String &value)
Definition: StreamDescription.h:490
Aws::Kinesis::Model::StreamDescription::WithEncryptionType
StreamDescription & WithEncryptionType(EncryptionType &&value)
Definition: StreamDescription.h:441
AWSVector.h
AWS_KINESIS_API
#define AWS_KINESIS_API
Definition: Kinesis_EXPORTS.h:28
Aws::Kinesis::Model::StreamDescription::WithStreamName
StreamDescription & WithStreamName(const char *value)
Definition: StreamDescription.h:85
Aws::Kinesis::Model::StreamDescription::SetKeyId
void SetKeyId(Aws::String &&value)
Definition: StreamDescription.h:506
Aws::Kinesis::Model::StreamDescription::HasMoreShardsHasBeenSet
bool HasMoreShardsHasBeenSet() const
Definition: StreamDescription.h:277
Aws::Kinesis::Model::StreamDescription::WithStreamCreationTimestamp
StreamDescription & WithStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: StreamDescription.h:345
Aws::Kinesis::Model::StreamDescription::AddShards
StreamDescription & AddShards(const Shard &value)
Definition: StreamDescription.h:259
Aws::Kinesis::Model::StreamDescription::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: StreamDescription.h:330
Aws::Kinesis::Model::StreamDescription::EncryptionTypeHasBeenSet
bool EncryptionTypeHasBeenSet() const
Definition: StreamDescription.h:405
Aws::Kinesis::Model::StreamDescription::WithEnhancedMonitoring
StreamDescription & WithEnhancedMonitoring(Aws::Vector< EnhancedMetrics > &&value)
Definition: StreamDescription.h:376
Aws::Kinesis::Model::StreamDescription::WithStreamARN
StreamDescription & WithStreamARN(const char *value)
Definition: StreamDescription.h:126
Aws::Kinesis::Model::StreamDescription::WithKeyId
StreamDescription & WithKeyId(Aws::String &&value)
Definition: StreamDescription.h:554
Aws::Kinesis::Model::StreamDescription::SetHasMoreShards
void SetHasMoreShards(bool value)
Definition: StreamDescription.h:283
Aws::Kinesis::Model::StreamDescription::StreamDescription
StreamDescription()
Aws::Kinesis::Model::StreamDescription::GetStreamARN
const Aws::String & GetStreamARN() const
Definition: StreamDescription.h:91
Aws::Kinesis::Model::StreamDescription::SetEnhancedMonitoring
void SetEnhancedMonitoring(Aws::Vector< EnhancedMetrics > &&value)
Definition: StreamDescription.h:366
Aws::Kinesis::Model::EnhancedMetrics
Definition: EnhancedMetrics.h:33
StreamStatus.h
Aws::Kinesis::Model::StreamDescription::StreamCreationTimestampHasBeenSet
bool StreamCreationTimestampHasBeenSet() const
Definition: StreamDescription.h:325
Aws::Kinesis::Model::StreamDescription::SetStreamStatus
void SetStreamStatus(StreamStatus &&value)
Definition: StreamDescription.h:191
Aws::Utils::Json::JsonView
Definition: JsonSerializer.h:235
AWSString.h
Aws::Kinesis::Model::StreamDescription::ShardsHasBeenSet
bool ShardsHasBeenSet() const
Definition: StreamDescription.h:234
Aws::Utils::Json::JsonValue
Definition: JsonSerializer.h:33
Aws::Kinesis::Model::StreamDescription::GetEncryptionType
const EncryptionType & GetEncryptionType() const
Definition: StreamDescription.h:396
Aws::Kinesis::Model::StreamDescription::GetStreamCreationTimestamp
const Aws::Utils::DateTime & GetStreamCreationTimestamp() const
Definition: StreamDescription.h:320
Aws::Kinesis::Model::StreamDescription::WithRetentionPeriodHours
StreamDescription & WithRetentionPeriodHours(int value)
Definition: StreamDescription.h:314
Aws::Kinesis::Model::StreamDescription::GetHasMoreShards
bool GetHasMoreShards() const
Definition: StreamDescription.h:271
Aws::Kinesis::Model::StreamDescription::WithHasMoreShards
StreamDescription & WithHasMoreShards(bool value)
Definition: StreamDescription.h:289
Kinesis_EXPORTS.h
Aws::Kinesis::Model::StreamDescription::AddEnhancedMonitoring
StreamDescription & AddEnhancedMonitoring(EnhancedMetrics &&value)
Definition: StreamDescription.h:386
Aws::Kinesis::Model::StreamDescription::SetStreamStatus
void SetStreamStatus(const StreamStatus &value)
Definition: StreamDescription.h:175
Aws::Kinesis::Model::StreamDescription::WithKeyId
StreamDescription & WithKeyId(const Aws::String &value)
Definition: StreamDescription.h:538
Aws::Kinesis::Model::EncryptionType
EncryptionType
Definition: EncryptionType.h:17
Aws::Kinesis::Model::Shard
Definition: Shard.h:35
Aws::Kinesis::Model::StreamDescription::SetRetentionPeriodHours
void SetRetentionPeriodHours(int value)
Definition: StreamDescription.h:308
Aws::Kinesis::Model::StreamDescription::WithStreamCreationTimestamp
StreamDescription & WithStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: StreamDescription.h:340
Aws
Definition: AccessManagementClient.h:15
Aws::Kinesis::Model::StreamDescription::StreamARNHasBeenSet
bool StreamARNHasBeenSet() const
Definition: StreamDescription.h:96
Aws::Kinesis::Model::StreamDescription::SetStreamARN
void SetStreamARN(const char *value)
Definition: StreamDescription.h:111
Aws::Kinesis::Model::StreamDescription::GetStreamStatus
const StreamStatus & GetStreamStatus() const
Definition: StreamDescription.h:143
Aws::Kinesis::Model::StreamDescription::AddShards
StreamDescription & AddShards(Shard &&value)
Definition: StreamDescription.h:264
Aws::Kinesis::Model::StreamDescription::SetEncryptionType
void SetEncryptionType(const EncryptionType &value)
Definition: StreamDescription.h:414
Aws::Kinesis::Model::StreamDescription::SetEnhancedMonitoring
void SetEnhancedMonitoring(const Aws::Vector< EnhancedMetrics > &value)
Definition: StreamDescription.h:361
Aws::Kinesis::Model::StreamDescription::GetKeyId
const Aws::String & GetKeyId() const
Definition: StreamDescription.h:458
Aws::Kinesis::Model::StreamDescription::WithStreamStatus
StreamDescription & WithStreamStatus(StreamStatus &&value)
Definition: StreamDescription.h:223
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Kinesis::Model::StreamDescription::StreamStatusHasBeenSet
bool StreamStatusHasBeenSet() const
Definition: StreamDescription.h:159
Aws::Kinesis::Model::StreamDescription::WithStreamName
StreamDescription & WithStreamName(Aws::String &&value)
Definition: StreamDescription.h:80
Aws::Kinesis::Model::StreamDescription
Definition: StreamDescription.h:39
Aws::Kinesis::Model::StreamDescription::WithStreamARN
StreamDescription & WithStreamARN(Aws::String &&value)
Definition: StreamDescription.h:121
Aws::Kinesis::Model::StreamDescription::WithStreamName
StreamDescription & WithStreamName(const Aws::String &value)
Definition: StreamDescription.h:75
Aws::Kinesis::Model::StreamDescription::WithEnhancedMonitoring
StreamDescription & WithEnhancedMonitoring(const Aws::Vector< EnhancedMetrics > &value)
Definition: StreamDescription.h:371
Aws::Kinesis::Model::StreamDescription::WithShards
StreamDescription & WithShards(Aws::Vector< Shard > &&value)
Definition: StreamDescription.h:254
Aws::Kinesis::Model::StreamDescription::GetEnhancedMonitoring
const Aws::Vector< EnhancedMetrics > & GetEnhancedMonitoring() const
Definition: StreamDescription.h:351
Aws::Kinesis::Model::StreamDescription::SetStreamName
void SetStreamName(const Aws::String &value)
Definition: StreamDescription.h:60
Shard.h
Aws::Kinesis::Model::StreamDescription::SetStreamName
void SetStreamName(Aws::String &&value)
Definition: StreamDescription.h:65
Aws::Kinesis::Model::StreamDescription::WithShards
StreamDescription & WithShards(const Aws::Vector< Shard > &value)
Definition: StreamDescription.h:249
Aws::Kinesis::Model::StreamDescription::SetEncryptionType
void SetEncryptionType(EncryptionType &&value)
Definition: StreamDescription.h:423