AWS SDK for C++

AWS SDK for C++ Version 1.11.906

Loading...
Searching...
No Matches
StreamDescriptionSummary.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/kinesis/Kinesis_EXPORTS.h>
11#include <aws/kinesis/model/EncryptionType.h>
12#include <aws/kinesis/model/EnhancedMetrics.h>
13#include <aws/kinesis/model/RecordDistributionStrategy.h>
14#include <aws/kinesis/model/StreamModeDetails.h>
15#include <aws/kinesis/model/StreamStatus.h>
16#include <aws/kinesis/model/WarmThroughputObject.h>
17
18#include <utility>
19
20namespace Aws {
21namespace Utils {
22namespace Json {
23class JsonValue;
24class JsonView;
25} // namespace Json
26} // namespace Utils
27namespace Kinesis {
28namespace Model {
29
37 public:
38 AWS_KINESIS_API StreamDescriptionSummary() = default;
41 AWS_KINESIS_API Aws::Utils::Json::JsonValue Jsonize() const;
42
44
47 inline const Aws::String& GetStreamName() const { return m_streamName; }
48 inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
49 template <typename StreamNameT = Aws::String>
50 void SetStreamName(StreamNameT&& value) {
51 m_streamNameHasBeenSet = true;
52 m_streamName = std::forward<StreamNameT>(value);
53 }
54 template <typename StreamNameT = Aws::String>
56 SetStreamName(std::forward<StreamNameT>(value));
57 return *this;
58 }
60
62
65 inline const Aws::String& GetStreamARN() const { return m_streamARN; }
66 inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
67 template <typename StreamARNT = Aws::String>
68 void SetStreamARN(StreamARNT&& value) {
69 m_streamARNHasBeenSet = true;
70 m_streamARN = std::forward<StreamARNT>(value);
71 }
72 template <typename StreamARNT = Aws::String>
74 SetStreamARN(std::forward<StreamARNT>(value));
75 return *this;
76 }
78
80
83 inline const Aws::String& GetStreamId() const { return m_streamId; }
84 inline bool StreamIdHasBeenSet() const { return m_streamIdHasBeenSet; }
85 template <typename StreamIdT = Aws::String>
86 void SetStreamId(StreamIdT&& value) {
87 m_streamIdHasBeenSet = true;
88 m_streamId = std::forward<StreamIdT>(value);
89 }
90 template <typename StreamIdT = Aws::String>
92 SetStreamId(std::forward<StreamIdT>(value));
93 return *this;
94 }
96
98
112 inline StreamStatus GetStreamStatus() const { return m_streamStatus; }
113 inline bool StreamStatusHasBeenSet() const { return m_streamStatusHasBeenSet; }
114 inline void SetStreamStatus(StreamStatus value) {
115 m_streamStatusHasBeenSet = true;
116 m_streamStatus = value;
117 }
119 SetStreamStatus(value);
120 return *this;
121 }
123
125
131 inline const StreamModeDetails& GetStreamModeDetails() const { return m_streamModeDetails; }
132 inline bool StreamModeDetailsHasBeenSet() const { return m_streamModeDetailsHasBeenSet; }
133 template <typename StreamModeDetailsT = StreamModeDetails>
134 void SetStreamModeDetails(StreamModeDetailsT&& value) {
135 m_streamModeDetailsHasBeenSet = true;
136 m_streamModeDetails = std::forward<StreamModeDetailsT>(value);
137 }
138 template <typename StreamModeDetailsT = StreamModeDetails>
139 StreamDescriptionSummary& WithStreamModeDetails(StreamModeDetailsT&& value) {
140 SetStreamModeDetails(std::forward<StreamModeDetailsT>(value));
141 return *this;
142 }
144
146
149 inline int GetRetentionPeriodHours() const { return m_retentionPeriodHours; }
150 inline bool RetentionPeriodHoursHasBeenSet() const { return m_retentionPeriodHoursHasBeenSet; }
151 inline void SetRetentionPeriodHours(int value) {
152 m_retentionPeriodHoursHasBeenSet = true;
153 m_retentionPeriodHours = value;
154 }
157 return *this;
158 }
160
162
165 inline const Aws::Utils::DateTime& GetStreamCreationTimestamp() const { return m_streamCreationTimestamp; }
166 inline bool StreamCreationTimestampHasBeenSet() const { return m_streamCreationTimestampHasBeenSet; }
167 template <typename StreamCreationTimestampT = Aws::Utils::DateTime>
168 void SetStreamCreationTimestamp(StreamCreationTimestampT&& value) {
169 m_streamCreationTimestampHasBeenSet = true;
170 m_streamCreationTimestamp = std::forward<StreamCreationTimestampT>(value);
171 }
172 template <typename StreamCreationTimestampT = Aws::Utils::DateTime>
173 StreamDescriptionSummary& WithStreamCreationTimestamp(StreamCreationTimestampT&& value) {
174 SetStreamCreationTimestamp(std::forward<StreamCreationTimestampT>(value));
175 return *this;
176 }
178
180
183 inline const Aws::Vector<EnhancedMetrics>& GetEnhancedMonitoring() const { return m_enhancedMonitoring; }
184 inline bool EnhancedMonitoringHasBeenSet() const { return m_enhancedMonitoringHasBeenSet; }
185 template <typename EnhancedMonitoringT = Aws::Vector<EnhancedMetrics>>
186 void SetEnhancedMonitoring(EnhancedMonitoringT&& value) {
187 m_enhancedMonitoringHasBeenSet = true;
188 m_enhancedMonitoring = std::forward<EnhancedMonitoringT>(value);
189 }
190 template <typename EnhancedMonitoringT = Aws::Vector<EnhancedMetrics>>
191 StreamDescriptionSummary& WithEnhancedMonitoring(EnhancedMonitoringT&& value) {
192 SetEnhancedMonitoring(std::forward<EnhancedMonitoringT>(value));
193 return *this;
194 }
195 template <typename EnhancedMonitoringT = EnhancedMetrics>
196 StreamDescriptionSummary& AddEnhancedMonitoring(EnhancedMonitoringT&& value) {
197 m_enhancedMonitoringHasBeenSet = true;
198 m_enhancedMonitoring.emplace_back(std::forward<EnhancedMonitoringT>(value));
199 return *this;
200 }
202
204
208 inline EncryptionType GetEncryptionType() const { return m_encryptionType; }
209 inline bool EncryptionTypeHasBeenSet() const { return m_encryptionTypeHasBeenSet; }
211 m_encryptionTypeHasBeenSet = true;
212 m_encryptionType = value;
213 }
215 SetEncryptionType(value);
216 return *this;
217 }
219
221
235 inline const Aws::String& GetKeyId() const { return m_keyId; }
236 inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
237 template <typename KeyIdT = Aws::String>
238 void SetKeyId(KeyIdT&& value) {
239 m_keyIdHasBeenSet = true;
240 m_keyId = std::forward<KeyIdT>(value);
241 }
242 template <typename KeyIdT = Aws::String>
244 SetKeyId(std::forward<KeyIdT>(value));
245 return *this;
246 }
248
250
253 inline int GetOpenShardCount() const { return m_openShardCount; }
254 inline bool OpenShardCountHasBeenSet() const { return m_openShardCountHasBeenSet; }
255 inline void SetOpenShardCount(int value) {
256 m_openShardCountHasBeenSet = true;
257 m_openShardCount = value;
258 }
260 SetOpenShardCount(value);
261 return *this;
262 }
264
266
269 inline int GetConsumerCount() const { return m_consumerCount; }
270 inline bool ConsumerCountHasBeenSet() const { return m_consumerCountHasBeenSet; }
271 inline void SetConsumerCount(int value) {
272 m_consumerCountHasBeenSet = true;
273 m_consumerCount = value;
274 }
276 SetConsumerCount(value);
277 return *this;
278 }
280
282
286 inline const WarmThroughputObject& GetWarmThroughput() const { return m_warmThroughput; }
287 inline bool WarmThroughputHasBeenSet() const { return m_warmThroughputHasBeenSet; }
288 template <typename WarmThroughputT = WarmThroughputObject>
289 void SetWarmThroughput(WarmThroughputT&& value) {
290 m_warmThroughputHasBeenSet = true;
291 m_warmThroughput = std::forward<WarmThroughputT>(value);
292 }
293 template <typename WarmThroughputT = WarmThroughputObject>
295 SetWarmThroughput(std::forward<WarmThroughputT>(value));
296 return *this;
297 }
299
301
305 inline int GetMaxRecordSizeInKiB() const { return m_maxRecordSizeInKiB; }
306 inline bool MaxRecordSizeInKiBHasBeenSet() const { return m_maxRecordSizeInKiBHasBeenSet; }
307 inline void SetMaxRecordSizeInKiB(int value) {
308 m_maxRecordSizeInKiBHasBeenSet = true;
309 m_maxRecordSizeInKiB = value;
310 }
313 return *this;
314 }
316
318
321 inline int GetChannelCount() const { return m_channelCount; }
322 inline bool ChannelCountHasBeenSet() const { return m_channelCountHasBeenSet; }
323 inline void SetChannelCount(int value) {
324 m_channelCountHasBeenSet = true;
325 m_channelCount = value;
326 }
328 SetChannelCount(value);
329 return *this;
330 }
332
334
342 inline RecordDistributionStrategy GetRecordDistributionStrategy() const { return m_recordDistributionStrategy; }
343 inline bool RecordDistributionStrategyHasBeenSet() const { return m_recordDistributionStrategyHasBeenSet; }
345 m_recordDistributionStrategyHasBeenSet = true;
346 m_recordDistributionStrategy = value;
347 }
350 return *this;
351 }
353 private:
354 Aws::String m_streamName;
355
356 Aws::String m_streamARN;
357
358 Aws::String m_streamId;
359
360 StreamStatus m_streamStatus{StreamStatus::NOT_SET};
361
362 StreamModeDetails m_streamModeDetails;
363
364 int m_retentionPeriodHours{0};
365
366 Aws::Utils::DateTime m_streamCreationTimestamp{};
367
368 Aws::Vector<EnhancedMetrics> m_enhancedMonitoring;
369
370 EncryptionType m_encryptionType{EncryptionType::NOT_SET};
371
372 Aws::String m_keyId;
373
374 int m_openShardCount{0};
375
376 int m_consumerCount{0};
377
378 WarmThroughputObject m_warmThroughput;
379
380 int m_maxRecordSizeInKiB{0};
381
382 int m_channelCount{0};
383
385 bool m_streamNameHasBeenSet = false;
386 bool m_streamARNHasBeenSet = false;
387 bool m_streamIdHasBeenSet = false;
388 bool m_streamStatusHasBeenSet = false;
389 bool m_streamModeDetailsHasBeenSet = false;
390 bool m_retentionPeriodHoursHasBeenSet = false;
391 bool m_streamCreationTimestampHasBeenSet = false;
392 bool m_enhancedMonitoringHasBeenSet = false;
393 bool m_encryptionTypeHasBeenSet = false;
394 bool m_keyIdHasBeenSet = false;
395 bool m_openShardCountHasBeenSet = false;
396 bool m_consumerCountHasBeenSet = false;
397 bool m_warmThroughputHasBeenSet = false;
398 bool m_maxRecordSizeInKiBHasBeenSet = false;
399 bool m_channelCountHasBeenSet = false;
400 bool m_recordDistributionStrategyHasBeenSet = false;
401};
402
403} // namespace Model
404} // namespace Kinesis
405} // namespace Aws
StreamDescriptionSummary & WithStreamId(StreamIdT &&value)
StreamDescriptionSummary & WithEnhancedMonitoring(EnhancedMonitoringT &&value)
const Aws::Vector< EnhancedMetrics > & GetEnhancedMonitoring() const
void SetStreamCreationTimestamp(StreamCreationTimestampT &&value)
const WarmThroughputObject & GetWarmThroughput() const
void SetRecordDistributionStrategy(RecordDistributionStrategy value)
StreamDescriptionSummary & WithEncryptionType(EncryptionType value)
StreamDescriptionSummary & WithOpenShardCount(int value)
StreamDescriptionSummary & WithRecordDistributionStrategy(RecordDistributionStrategy value)
const StreamModeDetails & GetStreamModeDetails() const
RecordDistributionStrategy GetRecordDistributionStrategy() const
StreamDescriptionSummary & AddEnhancedMonitoring(EnhancedMonitoringT &&value)
StreamDescriptionSummary & WithMaxRecordSizeInKiB(int value)
StreamDescriptionSummary & WithWarmThroughput(WarmThroughputT &&value)
StreamDescriptionSummary & WithStreamStatus(StreamStatus value)
StreamDescriptionSummary & WithRetentionPeriodHours(int value)
AWS_KINESIS_API StreamDescriptionSummary & operator=(Aws::Utils::Json::JsonView jsonValue)
StreamDescriptionSummary & WithStreamCreationTimestamp(StreamCreationTimestampT &&value)
StreamDescriptionSummary & WithKeyId(KeyIdT &&value)
const Aws::Utils::DateTime & GetStreamCreationTimestamp() const
AWS_KINESIS_API StreamDescriptionSummary()=default
AWS_KINESIS_API Aws::Utils::Json::JsonValue Jsonize() const
void SetEnhancedMonitoring(EnhancedMonitoringT &&value)
StreamDescriptionSummary & WithStreamARN(StreamARNT &&value)
AWS_KINESIS_API StreamDescriptionSummary(Aws::Utils::Json::JsonView jsonValue)
StreamDescriptionSummary & WithConsumerCount(int value)
StreamDescriptionSummary & WithChannelCount(int value)
StreamDescriptionSummary & WithStreamName(StreamNameT &&value)
StreamDescriptionSummary & WithStreamModeDetails(StreamModeDetailsT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue