AWS SDK for C++

AWS SDK for C++ Version 1.11.440

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();
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 inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
48 inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
49 inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
50 inline GetImagesRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
51 inline GetImagesRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
52 inline GetImagesRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;}
54
56
61 inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
62 inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
63 inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
64 inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
65 inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
66 inline GetImagesRequest& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
67 inline GetImagesRequest& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
68 inline GetImagesRequest& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
70
72
76 inline const ImageSelectorType& GetImageSelectorType() const{ return m_imageSelectorType; }
77 inline bool ImageSelectorTypeHasBeenSet() const { return m_imageSelectorTypeHasBeenSet; }
78 inline void SetImageSelectorType(const ImageSelectorType& value) { m_imageSelectorTypeHasBeenSet = true; m_imageSelectorType = value; }
79 inline void SetImageSelectorType(ImageSelectorType&& value) { m_imageSelectorTypeHasBeenSet = true; m_imageSelectorType = std::move(value); }
81 inline GetImagesRequest& WithImageSelectorType(ImageSelectorType&& value) { SetImageSelectorType(std::move(value)); return *this;}
83
85
90 inline const Aws::Utils::DateTime& GetStartTimestamp() const{ return m_startTimestamp; }
91 inline bool StartTimestampHasBeenSet() const { return m_startTimestampHasBeenSet; }
92 inline void SetStartTimestamp(const Aws::Utils::DateTime& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = value; }
93 inline void SetStartTimestamp(Aws::Utils::DateTime&& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = std::move(value); }
94 inline GetImagesRequest& WithStartTimestamp(const Aws::Utils::DateTime& value) { SetStartTimestamp(value); return *this;}
95 inline GetImagesRequest& WithStartTimestamp(Aws::Utils::DateTime&& value) { SetStartTimestamp(std::move(value)); return *this;}
97
99
105 inline const Aws::Utils::DateTime& GetEndTimestamp() const{ return m_endTimestamp; }
106 inline bool EndTimestampHasBeenSet() const { return m_endTimestampHasBeenSet; }
107 inline void SetEndTimestamp(const Aws::Utils::DateTime& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = value; }
108 inline void SetEndTimestamp(Aws::Utils::DateTime&& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = std::move(value); }
109 inline GetImagesRequest& WithEndTimestamp(const Aws::Utils::DateTime& value) { SetEndTimestamp(value); return *this;}
110 inline GetImagesRequest& WithEndTimestamp(Aws::Utils::DateTime&& value) { SetEndTimestamp(std::move(value)); return *this;}
112
114
121 inline int GetSamplingInterval() const{ return m_samplingInterval; }
122 inline bool SamplingIntervalHasBeenSet() const { return m_samplingIntervalHasBeenSet; }
123 inline void SetSamplingInterval(int value) { m_samplingIntervalHasBeenSet = true; m_samplingInterval = value; }
124 inline GetImagesRequest& WithSamplingInterval(int value) { SetSamplingInterval(value); return *this;}
126
128
131 inline const Format& GetFormat() const{ return m_format; }
132 inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; }
133 inline void SetFormat(const Format& value) { m_formatHasBeenSet = true; m_format = value; }
134 inline void SetFormat(Format&& value) { m_formatHasBeenSet = true; m_format = std::move(value); }
135 inline GetImagesRequest& WithFormat(const Format& value) { SetFormat(value); return *this;}
136 inline GetImagesRequest& WithFormat(Format&& value) { SetFormat(std::move(value)); return *this;}
138
140
150 inline const Aws::Map<FormatConfigKey, Aws::String>& GetFormatConfig() const{ return m_formatConfig; }
151 inline bool FormatConfigHasBeenSet() const { return m_formatConfigHasBeenSet; }
152 inline void SetFormatConfig(const Aws::Map<FormatConfigKey, Aws::String>& value) { m_formatConfigHasBeenSet = true; m_formatConfig = value; }
153 inline void SetFormatConfig(Aws::Map<FormatConfigKey, Aws::String>&& value) { m_formatConfigHasBeenSet = true; m_formatConfig = std::move(value); }
156 inline GetImagesRequest& AddFormatConfig(const FormatConfigKey& key, const Aws::String& value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(key, value); return *this; }
157 inline GetImagesRequest& AddFormatConfig(FormatConfigKey&& key, const Aws::String& value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(std::move(key), value); return *this; }
158 inline GetImagesRequest& AddFormatConfig(const FormatConfigKey& key, Aws::String&& value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(key, std::move(value)); return *this; }
159 inline GetImagesRequest& AddFormatConfig(FormatConfigKey&& key, Aws::String&& value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(std::move(key), std::move(value)); return *this; }
160 inline GetImagesRequest& AddFormatConfig(FormatConfigKey&& key, const char* value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(std::move(key), value); return *this; }
161 inline GetImagesRequest& AddFormatConfig(const FormatConfigKey& key, const char* value) { m_formatConfigHasBeenSet = true; m_formatConfig.emplace(key, value); return *this; }
163
165
174 inline int GetWidthPixels() const{ return m_widthPixels; }
175 inline bool WidthPixelsHasBeenSet() const { return m_widthPixelsHasBeenSet; }
176 inline void SetWidthPixels(int value) { m_widthPixelsHasBeenSet = true; m_widthPixels = value; }
177 inline GetImagesRequest& WithWidthPixels(int value) { SetWidthPixels(value); return *this;}
179
181
190 inline int GetHeightPixels() const{ return m_heightPixels; }
191 inline bool HeightPixelsHasBeenSet() const { return m_heightPixelsHasBeenSet; }
192 inline void SetHeightPixels(int value) { m_heightPixelsHasBeenSet = true; m_heightPixels = value; }
193 inline GetImagesRequest& WithHeightPixels(int value) { SetHeightPixels(value); return *this;}
195
197
203 inline long long GetMaxResults() const{ return m_maxResults; }
204 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
205 inline void SetMaxResults(long long value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
206 inline GetImagesRequest& WithMaxResults(long long value) { SetMaxResults(value); return *this;}
208
210
215 inline const Aws::String& GetNextToken() const{ return m_nextToken; }
216 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
217 inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
218 inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
219 inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
220 inline GetImagesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
221 inline GetImagesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
222 inline GetImagesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
224 private:
225
226 Aws::String m_streamName;
227 bool m_streamNameHasBeenSet = false;
228
229 Aws::String m_streamARN;
230 bool m_streamARNHasBeenSet = false;
231
232 ImageSelectorType m_imageSelectorType;
233 bool m_imageSelectorTypeHasBeenSet = false;
234
235 Aws::Utils::DateTime m_startTimestamp;
236 bool m_startTimestampHasBeenSet = false;
237
238 Aws::Utils::DateTime m_endTimestamp;
239 bool m_endTimestampHasBeenSet = false;
240
241 int m_samplingInterval;
242 bool m_samplingIntervalHasBeenSet = false;
243
244 Format m_format;
245 bool m_formatHasBeenSet = false;
246
248 bool m_formatConfigHasBeenSet = false;
249
250 int m_widthPixels;
251 bool m_widthPixelsHasBeenSet = false;
252
253 int m_heightPixels;
254 bool m_heightPixelsHasBeenSet = false;
255
256 long long m_maxResults;
257 bool m_maxResultsHasBeenSet = false;
258
259 Aws::String m_nextToken;
260 bool m_nextTokenHasBeenSet = false;
261 };
262
263} // namespace Model
264} // namespace KinesisVideoArchivedMedia
265} // namespace Aws
GetImagesRequest & WithStreamName(Aws::String &&value)
GetImagesRequest & AddFormatConfig(const FormatConfigKey &key, const char *value)
GetImagesRequest & WithStreamARN(const char *value)
GetImagesRequest & WithStartTimestamp(Aws::Utils::DateTime &&value)
GetImagesRequest & WithNextToken(Aws::String &&value)
void SetEndTimestamp(const Aws::Utils::DateTime &value)
GetImagesRequest & AddFormatConfig(FormatConfigKey &&key, Aws::String &&value)
GetImagesRequest & WithEndTimestamp(Aws::Utils::DateTime &&value)
void SetStartTimestamp(const Aws::Utils::DateTime &value)
GetImagesRequest & WithStartTimestamp(const Aws::Utils::DateTime &value)
void SetImageSelectorType(const ImageSelectorType &value)
GetImagesRequest & AddFormatConfig(const FormatConfigKey &key, Aws::String &&value)
void SetFormatConfig(Aws::Map< FormatConfigKey, Aws::String > &&value)
const Aws::Utils::DateTime & GetStartTimestamp() const
GetImagesRequest & WithFormat(const Format &value)
AWS_KINESISVIDEOARCHIVEDMEDIA_API GetImagesRequest()
GetImagesRequest & WithStreamARN(const Aws::String &value)
GetImagesRequest & AddFormatConfig(const FormatConfigKey &key, const Aws::String &value)
GetImagesRequest & WithFormatConfig(Aws::Map< FormatConfigKey, Aws::String > &&value)
const Aws::Map< FormatConfigKey, Aws::String > & GetFormatConfig() const
GetImagesRequest & AddFormatConfig(FormatConfigKey &&key, const Aws::String &value)
GetImagesRequest & WithNextToken(const char *value)
GetImagesRequest & WithFormatConfig(const Aws::Map< FormatConfigKey, Aws::String > &value)
GetImagesRequest & WithStreamARN(Aws::String &&value)
virtual const char * GetServiceRequestName() const override
GetImagesRequest & AddFormatConfig(FormatConfigKey &&key, const char *value)
void SetFormatConfig(const Aws::Map< FormatConfigKey, Aws::String > &value)
GetImagesRequest & WithImageSelectorType(const ImageSelectorType &value)
GetImagesRequest & WithStreamName(const Aws::String &value)
GetImagesRequest & WithEndTimestamp(const Aws::Utils::DateTime &value)
const Aws::Utils::DateTime & GetEndTimestamp() const
GetImagesRequest & WithNextToken(const Aws::String &value)
AWS_KINESISVIDEOARCHIVEDMEDIA_API Aws::String SerializePayload() const override
GetImagesRequest & WithImageSelectorType(ImageSelectorType &&value)
GetImagesRequest & WithStreamName(const char *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