AWS SDK for C++

AWS SDK for C++ Version 1.11.608

Loading...
Searching...
No Matches
GetImagesRequest.h
1
6#pragma once
7#include <aws/kinesis-video-archived-media/KinesisVideoArchivedMedia_EXPORTS.h>
8#include <aws/kinesis-video-archived-media/KinesisVideoArchivedMediaRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/kinesis-video-archived-media/model/ImageSelectorType.h>
11#include <aws/core/utils/DateTime.h>
12#include <aws/kinesis-video-archived-media/model/Format.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <aws/kinesis-video-archived-media/model/FormatConfigKey.h>
15#include <utility>
16
17namespace Aws
18{
19namespace KinesisVideoArchivedMedia
20{
21namespace Model
22{
23
27 {
28 public:
29 AWS_KINESISVIDEOARCHIVEDMEDIA_API GetImagesRequest() = default;
30
31 // Service request name is the Operation name which will send this request out,
32 // each operation should has unique request name, so that we can get operation's name from this request.
33 // Note: this is not true for response, multiple operations may have the same response name,
34 // so we can not get operation's name from response.
35 inline virtual const char* GetServiceRequestName() const override { return "GetImages"; }
36
37 AWS_KINESISVIDEOARCHIVEDMEDIA_API Aws::String SerializePayload() const override;
38
39
41
45 inline const Aws::String& GetStreamName() const { return m_streamName; }
46 inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
47 template<typename StreamNameT = Aws::String>
48 void SetStreamName(StreamNameT&& value) { m_streamNameHasBeenSet = true; m_streamName = std::forward<StreamNameT>(value); }
49 template<typename StreamNameT = Aws::String>
50 GetImagesRequest& WithStreamName(StreamNameT&& value) { SetStreamName(std::forward<StreamNameT>(value)); return *this;}
52
54
59 inline const Aws::String& GetStreamARN() const { return m_streamARN; }
60 inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
61 template<typename StreamARNT = Aws::String>
62 void SetStreamARN(StreamARNT&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::forward<StreamARNT>(value); }
63 template<typename StreamARNT = Aws::String>
64 GetImagesRequest& WithStreamARN(StreamARNT&& value) { SetStreamARN(std::forward<StreamARNT>(value)); return *this;}
66
68
72 inline ImageSelectorType GetImageSelectorType() const { return m_imageSelectorType; }
73 inline bool ImageSelectorTypeHasBeenSet() const { return m_imageSelectorTypeHasBeenSet; }
74 inline void SetImageSelectorType(ImageSelectorType value) { m_imageSelectorTypeHasBeenSet = true; m_imageSelectorType = value; }
77
79
84 inline const Aws::Utils::DateTime& GetStartTimestamp() const { return m_startTimestamp; }
85 inline bool StartTimestampHasBeenSet() const { return m_startTimestampHasBeenSet; }
86 template<typename StartTimestampT = Aws::Utils::DateTime>
87 void SetStartTimestamp(StartTimestampT&& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = std::forward<StartTimestampT>(value); }
88 template<typename StartTimestampT = Aws::Utils::DateTime>
89 GetImagesRequest& WithStartTimestamp(StartTimestampT&& value) { SetStartTimestamp(std::forward<StartTimestampT>(value)); return *this;}
91
93
99 inline const Aws::Utils::DateTime& GetEndTimestamp() const { return m_endTimestamp; }
100 inline bool EndTimestampHasBeenSet() const { return m_endTimestampHasBeenSet; }
101 template<typename EndTimestampT = Aws::Utils::DateTime>
102 void SetEndTimestamp(EndTimestampT&& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = std::forward<EndTimestampT>(value); }
103 template<typename EndTimestampT = Aws::Utils::DateTime>
104 GetImagesRequest& WithEndTimestamp(EndTimestampT&& value) { SetEndTimestamp(std::forward<EndTimestampT>(value)); return *this;}
106
108
115 inline int GetSamplingInterval() const { return m_samplingInterval; }
116 inline bool SamplingIntervalHasBeenSet() const { return m_samplingIntervalHasBeenSet; }
117 inline void SetSamplingInterval(int value) { m_samplingIntervalHasBeenSet = true; m_samplingInterval = value; }
118 inline GetImagesRequest& WithSamplingInterval(int value) { SetSamplingInterval(value); return *this;}
120
122
125 inline Format GetFormat() const { return m_format; }
126 inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; }
127 inline void SetFormat(Format value) { m_formatHasBeenSet = true; m_format = value; }
128 inline GetImagesRequest& WithFormat(Format value) { SetFormat(value); return *this;}
130
132
142 inline const Aws::Map<FormatConfigKey, Aws::String>& GetFormatConfig() const { return m_formatConfig; }
143 inline bool FormatConfigHasBeenSet() const { return m_formatConfigHasBeenSet; }
144 template<typename FormatConfigT = Aws::Map<FormatConfigKey, Aws::String>>
145 void SetFormatConfig(FormatConfigT&& value) { m_formatConfigHasBeenSet = true; m_formatConfig = std::forward<FormatConfigT>(value); }
146 template<typename FormatConfigT = Aws::Map<FormatConfigKey, Aws::String>>
147 GetImagesRequest& WithFormatConfig(FormatConfigT&& value) { SetFormatConfig(std::forward<FormatConfigT>(value)); return *this;}
149 m_formatConfigHasBeenSet = true; m_formatConfig.emplace(key, value); return *this;
150 }
152
154
163 inline int GetWidthPixels() const { return m_widthPixels; }
164 inline bool WidthPixelsHasBeenSet() const { return m_widthPixelsHasBeenSet; }
165 inline void SetWidthPixels(int value) { m_widthPixelsHasBeenSet = true; m_widthPixels = value; }
166 inline GetImagesRequest& WithWidthPixels(int value) { SetWidthPixels(value); return *this;}
168
170
179 inline int GetHeightPixels() const { return m_heightPixels; }
180 inline bool HeightPixelsHasBeenSet() const { return m_heightPixelsHasBeenSet; }
181 inline void SetHeightPixels(int value) { m_heightPixelsHasBeenSet = true; m_heightPixels = value; }
182 inline GetImagesRequest& WithHeightPixels(int value) { SetHeightPixels(value); return *this;}
184
186
192 inline long long GetMaxResults() const { return m_maxResults; }
193 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
194 inline void SetMaxResults(long long value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
195 inline GetImagesRequest& WithMaxResults(long long value) { SetMaxResults(value); return *this;}
197
199
204 inline const Aws::String& GetNextToken() const { return m_nextToken; }
205 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
206 template<typename NextTokenT = Aws::String>
207 void SetNextToken(NextTokenT&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::forward<NextTokenT>(value); }
208 template<typename NextTokenT = Aws::String>
209 GetImagesRequest& WithNextToken(NextTokenT&& value) { SetNextToken(std::forward<NextTokenT>(value)); return *this;}
211 private:
212
213 Aws::String m_streamName;
214 bool m_streamNameHasBeenSet = false;
215
216 Aws::String m_streamARN;
217 bool m_streamARNHasBeenSet = false;
218
220 bool m_imageSelectorTypeHasBeenSet = false;
221
222 Aws::Utils::DateTime m_startTimestamp{};
223 bool m_startTimestampHasBeenSet = false;
224
225 Aws::Utils::DateTime m_endTimestamp{};
226 bool m_endTimestampHasBeenSet = false;
227
228 int m_samplingInterval{0};
229 bool m_samplingIntervalHasBeenSet = false;
230
231 Format m_format{Format::NOT_SET};
232 bool m_formatHasBeenSet = false;
233
235 bool m_formatConfigHasBeenSet = false;
236
237 int m_widthPixels{0};
238 bool m_widthPixelsHasBeenSet = false;
239
240 int m_heightPixels{0};
241 bool m_heightPixelsHasBeenSet = false;
242
243 long long m_maxResults{0};
244 bool m_maxResultsHasBeenSet = false;
245
246 Aws::String m_nextToken;
247 bool m_nextTokenHasBeenSet = false;
248 };
249
250} // namespace Model
251} // namespace KinesisVideoArchivedMedia
252} // namespace Aws
GetImagesRequest & WithStartTimestamp(StartTimestampT &&value)
GetImagesRequest & AddFormatConfig(FormatConfigKey key, Aws::String value)
const Aws::Utils::DateTime & GetStartTimestamp() const
GetImagesRequest & WithStreamARN(StreamARNT &&value)
const Aws::Map< FormatConfigKey, Aws::String > & GetFormatConfig() const
GetImagesRequest & WithFormatConfig(FormatConfigT &&value)
GetImagesRequest & WithNextToken(NextTokenT &&value)
GetImagesRequest & WithImageSelectorType(ImageSelectorType value)
virtual const char * GetServiceRequestName() const override
GetImagesRequest & WithEndTimestamp(EndTimestampT &&value)
const Aws::Utils::DateTime & GetEndTimestamp() const
AWS_KINESISVIDEOARCHIVEDMEDIA_API GetImagesRequest()=default
AWS_KINESISVIDEOARCHIVEDMEDIA_API Aws::String SerializePayload() const override
GetImagesRequest & WithStreamName(StreamNameT &&value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String