AWS SDK for C++  1.9.103
AWS SDK for C++
StreamDescriptionSummary.h
Go to the documentation of this file.
1 
6 #pragma once
14 #include <utility>
15 
16 namespace Aws
17 {
18 namespace Utils
19 {
20 namespace Json
21 {
22  class JsonValue;
23  class JsonView;
24 } // namespace Json
25 } // namespace Utils
26 namespace Kinesis
27 {
28 namespace Model
29 {
30 
38  {
39  public:
44 
45 
49  inline const Aws::String& GetStreamName() const{ return m_streamName; }
50 
54  inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
55 
59  inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
60 
64  inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
65 
69  inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
70 
74  inline StreamDescriptionSummary& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
75 
79  inline StreamDescriptionSummary& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
80 
84  inline StreamDescriptionSummary& WithStreamName(const char* value) { SetStreamName(value); return *this;}
85 
86 
90  inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
91 
95  inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
96 
100  inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
101 
105  inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
106 
110  inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
111 
115  inline StreamDescriptionSummary& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
116 
120  inline StreamDescriptionSummary& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
121 
125  inline StreamDescriptionSummary& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
126 
127 
142  inline const StreamStatus& GetStreamStatus() const{ return m_streamStatus; }
143 
158  inline bool StreamStatusHasBeenSet() const { return m_streamStatusHasBeenSet; }
159 
174  inline void SetStreamStatus(const StreamStatus& value) { m_streamStatusHasBeenSet = true; m_streamStatus = value; }
175 
190  inline void SetStreamStatus(StreamStatus&& value) { m_streamStatusHasBeenSet = true; m_streamStatus = std::move(value); }
191 
206  inline StreamDescriptionSummary& WithStreamStatus(const StreamStatus& value) { SetStreamStatus(value); return *this;}
207 
222  inline StreamDescriptionSummary& WithStreamStatus(StreamStatus&& value) { SetStreamStatus(std::move(value)); return *this;}
223 
224 
228  inline int GetRetentionPeriodHours() const{ return m_retentionPeriodHours; }
229 
233  inline bool RetentionPeriodHoursHasBeenSet() const { return m_retentionPeriodHoursHasBeenSet; }
234 
238  inline void SetRetentionPeriodHours(int value) { m_retentionPeriodHoursHasBeenSet = true; m_retentionPeriodHours = value; }
239 
243  inline StreamDescriptionSummary& WithRetentionPeriodHours(int value) { SetRetentionPeriodHours(value); return *this;}
244 
245 
249  inline const Aws::Utils::DateTime& GetStreamCreationTimestamp() const{ return m_streamCreationTimestamp; }
250 
254  inline bool StreamCreationTimestampHasBeenSet() const { return m_streamCreationTimestampHasBeenSet; }
255 
259  inline void SetStreamCreationTimestamp(const Aws::Utils::DateTime& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = value; }
260 
264  inline void SetStreamCreationTimestamp(Aws::Utils::DateTime&& value) { m_streamCreationTimestampHasBeenSet = true; m_streamCreationTimestamp = std::move(value); }
265 
269  inline StreamDescriptionSummary& WithStreamCreationTimestamp(const Aws::Utils::DateTime& value) { SetStreamCreationTimestamp(value); return *this;}
270 
274  inline StreamDescriptionSummary& WithStreamCreationTimestamp(Aws::Utils::DateTime&& value) { SetStreamCreationTimestamp(std::move(value)); return *this;}
275 
276 
280  inline const Aws::Vector<EnhancedMetrics>& GetEnhancedMonitoring() const{ return m_enhancedMonitoring; }
281 
285  inline bool EnhancedMonitoringHasBeenSet() const { return m_enhancedMonitoringHasBeenSet; }
286 
290  inline void SetEnhancedMonitoring(const Aws::Vector<EnhancedMetrics>& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring = value; }
291 
295  inline void SetEnhancedMonitoring(Aws::Vector<EnhancedMetrics>&& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring = std::move(value); }
296 
300  inline StreamDescriptionSummary& WithEnhancedMonitoring(const Aws::Vector<EnhancedMetrics>& value) { SetEnhancedMonitoring(value); return *this;}
301 
305  inline StreamDescriptionSummary& WithEnhancedMonitoring(Aws::Vector<EnhancedMetrics>&& value) { SetEnhancedMonitoring(std::move(value)); return *this;}
306 
310  inline StreamDescriptionSummary& AddEnhancedMonitoring(const EnhancedMetrics& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring.push_back(value); return *this; }
311 
315  inline StreamDescriptionSummary& AddEnhancedMonitoring(EnhancedMetrics&& value) { m_enhancedMonitoringHasBeenSet = true; m_enhancedMonitoring.push_back(std::move(value)); return *this; }
316 
317 
322  inline const EncryptionType& GetEncryptionType() const{ return m_encryptionType; }
323 
328  inline bool EncryptionTypeHasBeenSet() const { return m_encryptionTypeHasBeenSet; }
329 
334  inline void SetEncryptionType(const EncryptionType& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = value; }
335 
340  inline void SetEncryptionType(EncryptionType&& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = std::move(value); }
341 
346  inline StreamDescriptionSummary& WithEncryptionType(const EncryptionType& value) { SetEncryptionType(value); return *this;}
347 
352  inline StreamDescriptionSummary& WithEncryptionType(EncryptionType&& value) { SetEncryptionType(std::move(value)); return *this;}
353 
354 
369  inline const Aws::String& GetKeyId() const{ return m_keyId; }
370 
385  inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
386 
401  inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
402 
417  inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
418 
433  inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
434 
449  inline StreamDescriptionSummary& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
450 
465  inline StreamDescriptionSummary& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
466 
481  inline StreamDescriptionSummary& WithKeyId(const char* value) { SetKeyId(value); return *this;}
482 
483 
487  inline int GetOpenShardCount() const{ return m_openShardCount; }
488 
492  inline bool OpenShardCountHasBeenSet() const { return m_openShardCountHasBeenSet; }
493 
497  inline void SetOpenShardCount(int value) { m_openShardCountHasBeenSet = true; m_openShardCount = value; }
498 
502  inline StreamDescriptionSummary& WithOpenShardCount(int value) { SetOpenShardCount(value); return *this;}
503 
504 
508  inline int GetConsumerCount() const{ return m_consumerCount; }
509 
513  inline bool ConsumerCountHasBeenSet() const { return m_consumerCountHasBeenSet; }
514 
518  inline void SetConsumerCount(int value) { m_consumerCountHasBeenSet = true; m_consumerCount = value; }
519 
523  inline StreamDescriptionSummary& WithConsumerCount(int value) { SetConsumerCount(value); return *this;}
524 
525  private:
526 
527  Aws::String m_streamName;
528  bool m_streamNameHasBeenSet;
529 
530  Aws::String m_streamARN;
531  bool m_streamARNHasBeenSet;
532 
533  StreamStatus m_streamStatus;
534  bool m_streamStatusHasBeenSet;
535 
536  int m_retentionPeriodHours;
537  bool m_retentionPeriodHoursHasBeenSet;
538 
539  Aws::Utils::DateTime m_streamCreationTimestamp;
540  bool m_streamCreationTimestampHasBeenSet;
541 
542  Aws::Vector<EnhancedMetrics> m_enhancedMonitoring;
543  bool m_enhancedMonitoringHasBeenSet;
544 
545  EncryptionType m_encryptionType;
546  bool m_encryptionTypeHasBeenSet;
547 
548  Aws::String m_keyId;
549  bool m_keyIdHasBeenSet;
550 
551  int m_openShardCount;
552  bool m_openShardCountHasBeenSet;
553 
554  int m_consumerCount;
555  bool m_consumerCountHasBeenSet;
556  };
557 
558 } // namespace Model
559 } // namespace Kinesis
560 } // namespace Aws
Aws::Kinesis::Model::StreamDescriptionSummary::StreamARNHasBeenSet
bool StreamARNHasBeenSet() const
Definition: StreamDescriptionSummary.h:95
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamStatus
StreamDescriptionSummary & WithStreamStatus(const StreamStatus &value)
Definition: StreamDescriptionSummary.h:206
Aws::Kinesis::Model::StreamStatus
StreamStatus
Definition: StreamStatus.h:17
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamARN
void SetStreamARN(const char *value)
Definition: StreamDescriptionSummary.h:110
Aws::Kinesis::Model::StreamDescriptionSummary::SetKeyId
void SetKeyId(Aws::String &&value)
Definition: StreamDescriptionSummary.h:417
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamARN
StreamDescriptionSummary & WithStreamARN(const char *value)
Definition: StreamDescriptionSummary.h:125
Aws::Kinesis::Model::StreamDescriptionSummary::WithEnhancedMonitoring
StreamDescriptionSummary & WithEnhancedMonitoring(const Aws::Vector< EnhancedMetrics > &value)
Definition: StreamDescriptionSummary.h:300
Aws::Kinesis::Model::StreamDescriptionSummary::SetConsumerCount
void SetConsumerCount(int value)
Definition: StreamDescriptionSummary.h:518
DateTime.h
Aws::Kinesis::Model::StreamDescriptionSummary::GetKeyId
const Aws::String & GetKeyId() const
Definition: StreamDescriptionSummary.h:369
Aws::Kinesis::Model::StreamDescriptionSummary::GetStreamStatus
const StreamStatus & GetStreamStatus() const
Definition: StreamDescriptionSummary.h:142
EnhancedMetrics.h
Aws::Kinesis::Model::StreamDescriptionSummary::RetentionPeriodHoursHasBeenSet
bool RetentionPeriodHoursHasBeenSet() const
Definition: StreamDescriptionSummary.h:233
EncryptionType.h
Aws::Kinesis::Model::StreamDescriptionSummary::StreamStatusHasBeenSet
bool StreamStatusHasBeenSet() const
Definition: StreamDescriptionSummary.h:158
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: StreamDescriptionSummary.h:264
Aws::Kinesis::Model::StreamDescriptionSummary::WithOpenShardCount
StreamDescriptionSummary & WithOpenShardCount(int value)
Definition: StreamDescriptionSummary.h:502
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::Kinesis::Model::StreamDescriptionSummary::SetRetentionPeriodHours
void SetRetentionPeriodHours(int value)
Definition: StreamDescriptionSummary.h:238
Aws::Kinesis::Model::StreamDescriptionSummary::EnhancedMonitoringHasBeenSet
bool EnhancedMonitoringHasBeenSet() const
Definition: StreamDescriptionSummary.h:285
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamStatus
void SetStreamStatus(StreamStatus &&value)
Definition: StreamDescriptionSummary.h:190
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamCreationTimestamp
StreamDescriptionSummary & WithStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: StreamDescriptionSummary.h:269
Aws::Kinesis::Model::StreamDescriptionSummary::StreamCreationTimestampHasBeenSet
bool StreamCreationTimestampHasBeenSet() const
Definition: StreamDescriptionSummary.h:254
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamName
StreamDescriptionSummary & WithStreamName(Aws::String &&value)
Definition: StreamDescriptionSummary.h:79
Aws::Kinesis::Model::StreamDescriptionSummary::GetEncryptionType
const EncryptionType & GetEncryptionType() const
Definition: StreamDescriptionSummary.h:322
AWSVector.h
AWS_KINESIS_API
#define AWS_KINESIS_API
Definition: Kinesis_EXPORTS.h:28
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamStatus
void SetStreamStatus(const StreamStatus &value)
Definition: StreamDescriptionSummary.h:174
Aws::Kinesis::Model::StreamDescriptionSummary::AddEnhancedMonitoring
StreamDescriptionSummary & AddEnhancedMonitoring(EnhancedMetrics &&value)
Definition: StreamDescriptionSummary.h:315
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamARN
StreamDescriptionSummary & WithStreamARN(const Aws::String &value)
Definition: StreamDescriptionSummary.h:115
Aws::Kinesis::Model::StreamDescriptionSummary::SetOpenShardCount
void SetOpenShardCount(int value)
Definition: StreamDescriptionSummary.h:497
Aws::Kinesis::Model::StreamDescriptionSummary::EncryptionTypeHasBeenSet
bool EncryptionTypeHasBeenSet() const
Definition: StreamDescriptionSummary.h:328
Aws::Kinesis::Model::StreamDescriptionSummary::WithEnhancedMonitoring
StreamDescriptionSummary & WithEnhancedMonitoring(Aws::Vector< EnhancedMetrics > &&value)
Definition: StreamDescriptionSummary.h:305
Aws::Kinesis::Model::StreamDescriptionSummary::SetEnhancedMonitoring
void SetEnhancedMonitoring(const Aws::Vector< EnhancedMetrics > &value)
Definition: StreamDescriptionSummary.h:290
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamName
StreamDescriptionSummary & WithStreamName(const Aws::String &value)
Definition: StreamDescriptionSummary.h:74
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamARN
void SetStreamARN(Aws::String &&value)
Definition: StreamDescriptionSummary.h:105
Aws::Kinesis::Model::StreamDescriptionSummary::WithEncryptionType
StreamDescriptionSummary & WithEncryptionType(EncryptionType &&value)
Definition: StreamDescriptionSummary.h:352
Aws::Kinesis::Model::EnhancedMetrics
Definition: EnhancedMetrics.h:33
StreamStatus.h
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamName
void SetStreamName(const char *value)
Definition: StreamDescriptionSummary.h:69
Aws::Kinesis::Model::StreamDescriptionSummary::GetOpenShardCount
int GetOpenShardCount() const
Definition: StreamDescriptionSummary.h:487
Aws::Utils::Json::JsonView
Definition: JsonSerializer.h:235
Aws::Kinesis::Model::StreamDescriptionSummary::StreamDescriptionSummary
StreamDescriptionSummary(Aws::Utils::Json::JsonView jsonValue)
AWSString.h
Aws::Kinesis::Model::StreamDescriptionSummary::GetConsumerCount
int GetConsumerCount() const
Definition: StreamDescriptionSummary.h:508
Aws::Utils::Json::JsonValue
Definition: JsonSerializer.h:33
Aws::Kinesis::Model::StreamDescriptionSummary::WithKeyId
StreamDescriptionSummary & WithKeyId(const char *value)
Definition: StreamDescriptionSummary.h:481
Aws::Kinesis::Model::StreamDescriptionSummary::StreamNameHasBeenSet
bool StreamNameHasBeenSet() const
Definition: StreamDescriptionSummary.h:54
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamStatus
StreamDescriptionSummary & WithStreamStatus(StreamStatus &&value)
Definition: StreamDescriptionSummary.h:222
Aws::Kinesis::Model::StreamDescriptionSummary::WithRetentionPeriodHours
StreamDescriptionSummary & WithRetentionPeriodHours(int value)
Definition: StreamDescriptionSummary.h:243
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamARN
StreamDescriptionSummary & WithStreamARN(Aws::String &&value)
Definition: StreamDescriptionSummary.h:120
Aws::Kinesis::Model::StreamDescriptionSummary::WithConsumerCount
StreamDescriptionSummary & WithConsumerCount(int value)
Definition: StreamDescriptionSummary.h:523
Aws::Kinesis::Model::StreamDescriptionSummary::GetStreamARN
const Aws::String & GetStreamARN() const
Definition: StreamDescriptionSummary.h:90
Aws::Kinesis::Model::StreamDescriptionSummary::operator=
StreamDescriptionSummary & operator=(Aws::Utils::Json::JsonView jsonValue)
Aws::Kinesis::Model::StreamDescriptionSummary::ConsumerCountHasBeenSet
bool ConsumerCountHasBeenSet() const
Definition: StreamDescriptionSummary.h:513
Aws::Kinesis::Model::StreamDescriptionSummary::GetStreamName
const Aws::String & GetStreamName() const
Definition: StreamDescriptionSummary.h:49
Aws::Kinesis::Model::StreamDescriptionSummary::SetKeyId
void SetKeyId(const char *value)
Definition: StreamDescriptionSummary.h:433
Kinesis_EXPORTS.h
Aws::Kinesis::Model::StreamDescriptionSummary::StreamDescriptionSummary
StreamDescriptionSummary()
Aws::Kinesis::Model::EncryptionType
EncryptionType
Definition: EncryptionType.h:17
Aws::Kinesis::Model::StreamDescriptionSummary::GetEnhancedMonitoring
const Aws::Vector< EnhancedMetrics > & GetEnhancedMonitoring() const
Definition: StreamDescriptionSummary.h:280
Aws::Kinesis::Model::StreamDescriptionSummary::OpenShardCountHasBeenSet
bool OpenShardCountHasBeenSet() const
Definition: StreamDescriptionSummary.h:492
Aws::Kinesis::Model::StreamDescriptionSummary::WithEncryptionType
StreamDescriptionSummary & WithEncryptionType(const EncryptionType &value)
Definition: StreamDescriptionSummary.h:346
Aws
Definition: AccessManagementClient.h:15
Aws::Kinesis::Model::StreamDescriptionSummary::SetEncryptionType
void SetEncryptionType(const EncryptionType &value)
Definition: StreamDescriptionSummary.h:334
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamName
StreamDescriptionSummary & WithStreamName(const char *value)
Definition: StreamDescriptionSummary.h:84
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamName
void SetStreamName(const Aws::String &value)
Definition: StreamDescriptionSummary.h:59
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamARN
void SetStreamARN(const Aws::String &value)
Definition: StreamDescriptionSummary.h:100
Aws::Kinesis::Model::StreamDescriptionSummary::SetKeyId
void SetKeyId(const Aws::String &value)
Definition: StreamDescriptionSummary.h:401
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Kinesis::Model::StreamDescriptionSummary::WithStreamCreationTimestamp
StreamDescriptionSummary & WithStreamCreationTimestamp(Aws::Utils::DateTime &&value)
Definition: StreamDescriptionSummary.h:274
Aws::Kinesis::Model::StreamDescriptionSummary::WithKeyId
StreamDescriptionSummary & WithKeyId(Aws::String &&value)
Definition: StreamDescriptionSummary.h:465
Aws::Kinesis::Model::StreamDescriptionSummary::WithKeyId
StreamDescriptionSummary & WithKeyId(const Aws::String &value)
Definition: StreamDescriptionSummary.h:449
Aws::Kinesis::Model::StreamDescriptionSummary::KeyIdHasBeenSet
bool KeyIdHasBeenSet() const
Definition: StreamDescriptionSummary.h:385
Aws::Kinesis::Model::StreamDescriptionSummary::GetStreamCreationTimestamp
const Aws::Utils::DateTime & GetStreamCreationTimestamp() const
Definition: StreamDescriptionSummary.h:249
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamCreationTimestamp
void SetStreamCreationTimestamp(const Aws::Utils::DateTime &value)
Definition: StreamDescriptionSummary.h:259
Aws::Kinesis::Model::StreamDescriptionSummary::AddEnhancedMonitoring
StreamDescriptionSummary & AddEnhancedMonitoring(const EnhancedMetrics &value)
Definition: StreamDescriptionSummary.h:310
Aws::Kinesis::Model::StreamDescriptionSummary::GetRetentionPeriodHours
int GetRetentionPeriodHours() const
Definition: StreamDescriptionSummary.h:228
Aws::Kinesis::Model::StreamDescriptionSummary
Definition: StreamDescriptionSummary.h:38
Aws::Kinesis::Model::StreamDescriptionSummary::SetEncryptionType
void SetEncryptionType(EncryptionType &&value)
Definition: StreamDescriptionSummary.h:340
Aws::Kinesis::Model::StreamDescriptionSummary::SetStreamName
void SetStreamName(Aws::String &&value)
Definition: StreamDescriptionSummary.h:64
Aws::Kinesis::Model::StreamDescriptionSummary::Jsonize
Aws::Utils::Json::JsonValue Jsonize() const
Aws::Kinesis::Model::StreamDescriptionSummary::SetEnhancedMonitoring
void SetEnhancedMonitoring(Aws::Vector< EnhancedMetrics > &&value)
Definition: StreamDescriptionSummary.h:295