AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
CreateOTAUpdateRequest.h
1
6#pragma once
7#include <aws/iot/IoT_EXPORTS.h>
8#include <aws/iot/IoTRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/iot/model/TargetSelection.h>
12#include <aws/iot/model/AwsJobExecutionsRolloutConfig.h>
13#include <aws/iot/model/AwsJobPresignedUrlConfig.h>
14#include <aws/iot/model/AwsJobAbortConfig.h>
15#include <aws/iot/model/AwsJobTimeoutConfig.h>
16#include <aws/core/utils/memory/stl/AWSMap.h>
17#include <aws/iot/model/Protocol.h>
18#include <aws/iot/model/OTAUpdateFile.h>
19#include <aws/iot/model/Tag.h>
20#include <utility>
21
22namespace Aws
23{
24namespace IoT
25{
26namespace Model
27{
28
32 {
33 public:
35
36 // Service request name is the Operation name which will send this request out,
37 // each operation should has unique request name, so that we can get operation's name from this request.
38 // Note: this is not true for response, multiple operations may have the same response name,
39 // so we can not get operation's name from response.
40 inline virtual const char* GetServiceRequestName() const override { return "CreateOTAUpdate"; }
41
42 AWS_IOT_API Aws::String SerializePayload() const override;
43
44
46
49 inline const Aws::String& GetOtaUpdateId() const{ return m_otaUpdateId; }
50 inline bool OtaUpdateIdHasBeenSet() const { return m_otaUpdateIdHasBeenSet; }
51 inline void SetOtaUpdateId(const Aws::String& value) { m_otaUpdateIdHasBeenSet = true; m_otaUpdateId = value; }
52 inline void SetOtaUpdateId(Aws::String&& value) { m_otaUpdateIdHasBeenSet = true; m_otaUpdateId = std::move(value); }
53 inline void SetOtaUpdateId(const char* value) { m_otaUpdateIdHasBeenSet = true; m_otaUpdateId.assign(value); }
54 inline CreateOTAUpdateRequest& WithOtaUpdateId(const Aws::String& value) { SetOtaUpdateId(value); return *this;}
55 inline CreateOTAUpdateRequest& WithOtaUpdateId(Aws::String&& value) { SetOtaUpdateId(std::move(value)); return *this;}
56 inline CreateOTAUpdateRequest& WithOtaUpdateId(const char* value) { SetOtaUpdateId(value); return *this;}
58
60
63 inline const Aws::String& GetDescription() const{ return m_description; }
64 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
65 inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
66 inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
67 inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
68 inline CreateOTAUpdateRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
69 inline CreateOTAUpdateRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
70 inline CreateOTAUpdateRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
72
74
77 inline const Aws::Vector<Aws::String>& GetTargets() const{ return m_targets; }
78 inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; }
79 inline void SetTargets(const Aws::Vector<Aws::String>& value) { m_targetsHasBeenSet = true; m_targets = value; }
80 inline void SetTargets(Aws::Vector<Aws::String>&& value) { m_targetsHasBeenSet = true; m_targets = std::move(value); }
81 inline CreateOTAUpdateRequest& WithTargets(const Aws::Vector<Aws::String>& value) { SetTargets(value); return *this;}
82 inline CreateOTAUpdateRequest& WithTargets(Aws::Vector<Aws::String>&& value) { SetTargets(std::move(value)); return *this;}
83 inline CreateOTAUpdateRequest& AddTargets(const Aws::String& value) { m_targetsHasBeenSet = true; m_targets.push_back(value); return *this; }
84 inline CreateOTAUpdateRequest& AddTargets(Aws::String&& value) { m_targetsHasBeenSet = true; m_targets.push_back(std::move(value)); return *this; }
85 inline CreateOTAUpdateRequest& AddTargets(const char* value) { m_targetsHasBeenSet = true; m_targets.push_back(value); return *this; }
87
89
94 inline const Aws::Vector<Protocol>& GetProtocols() const{ return m_protocols; }
95 inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; }
96 inline void SetProtocols(const Aws::Vector<Protocol>& value) { m_protocolsHasBeenSet = true; m_protocols = value; }
97 inline void SetProtocols(Aws::Vector<Protocol>&& value) { m_protocolsHasBeenSet = true; m_protocols = std::move(value); }
98 inline CreateOTAUpdateRequest& WithProtocols(const Aws::Vector<Protocol>& value) { SetProtocols(value); return *this;}
99 inline CreateOTAUpdateRequest& WithProtocols(Aws::Vector<Protocol>&& value) { SetProtocols(std::move(value)); return *this;}
100 inline CreateOTAUpdateRequest& AddProtocols(const Protocol& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(value); return *this; }
101 inline CreateOTAUpdateRequest& AddProtocols(Protocol&& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(std::move(value)); return *this; }
103
105
113 inline const TargetSelection& GetTargetSelection() const{ return m_targetSelection; }
114 inline bool TargetSelectionHasBeenSet() const { return m_targetSelectionHasBeenSet; }
115 inline void SetTargetSelection(const TargetSelection& value) { m_targetSelectionHasBeenSet = true; m_targetSelection = value; }
116 inline void SetTargetSelection(TargetSelection&& value) { m_targetSelectionHasBeenSet = true; m_targetSelection = std::move(value); }
118 inline CreateOTAUpdateRequest& WithTargetSelection(TargetSelection&& value) { SetTargetSelection(std::move(value)); return *this;}
120
122
125 inline const AwsJobExecutionsRolloutConfig& GetAwsJobExecutionsRolloutConfig() const{ return m_awsJobExecutionsRolloutConfig; }
126 inline bool AwsJobExecutionsRolloutConfigHasBeenSet() const { return m_awsJobExecutionsRolloutConfigHasBeenSet; }
127 inline void SetAwsJobExecutionsRolloutConfig(const AwsJobExecutionsRolloutConfig& value) { m_awsJobExecutionsRolloutConfigHasBeenSet = true; m_awsJobExecutionsRolloutConfig = value; }
128 inline void SetAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig&& value) { m_awsJobExecutionsRolloutConfigHasBeenSet = true; m_awsJobExecutionsRolloutConfig = std::move(value); }
132
134
137 inline const AwsJobPresignedUrlConfig& GetAwsJobPresignedUrlConfig() const{ return m_awsJobPresignedUrlConfig; }
138 inline bool AwsJobPresignedUrlConfigHasBeenSet() const { return m_awsJobPresignedUrlConfigHasBeenSet; }
139 inline void SetAwsJobPresignedUrlConfig(const AwsJobPresignedUrlConfig& value) { m_awsJobPresignedUrlConfigHasBeenSet = true; m_awsJobPresignedUrlConfig = value; }
140 inline void SetAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig&& value) { m_awsJobPresignedUrlConfigHasBeenSet = true; m_awsJobPresignedUrlConfig = std::move(value); }
144
146
149 inline const AwsJobAbortConfig& GetAwsJobAbortConfig() const{ return m_awsJobAbortConfig; }
150 inline bool AwsJobAbortConfigHasBeenSet() const { return m_awsJobAbortConfigHasBeenSet; }
151 inline void SetAwsJobAbortConfig(const AwsJobAbortConfig& value) { m_awsJobAbortConfigHasBeenSet = true; m_awsJobAbortConfig = value; }
152 inline void SetAwsJobAbortConfig(AwsJobAbortConfig&& value) { m_awsJobAbortConfigHasBeenSet = true; m_awsJobAbortConfig = std::move(value); }
154 inline CreateOTAUpdateRequest& WithAwsJobAbortConfig(AwsJobAbortConfig&& value) { SetAwsJobAbortConfig(std::move(value)); return *this;}
156
158
165 inline const AwsJobTimeoutConfig& GetAwsJobTimeoutConfig() const{ return m_awsJobTimeoutConfig; }
166 inline bool AwsJobTimeoutConfigHasBeenSet() const { return m_awsJobTimeoutConfigHasBeenSet; }
167 inline void SetAwsJobTimeoutConfig(const AwsJobTimeoutConfig& value) { m_awsJobTimeoutConfigHasBeenSet = true; m_awsJobTimeoutConfig = value; }
168 inline void SetAwsJobTimeoutConfig(AwsJobTimeoutConfig&& value) { m_awsJobTimeoutConfigHasBeenSet = true; m_awsJobTimeoutConfig = std::move(value); }
172
174
177 inline const Aws::Vector<OTAUpdateFile>& GetFiles() const{ return m_files; }
178 inline bool FilesHasBeenSet() const { return m_filesHasBeenSet; }
179 inline void SetFiles(const Aws::Vector<OTAUpdateFile>& value) { m_filesHasBeenSet = true; m_files = value; }
180 inline void SetFiles(Aws::Vector<OTAUpdateFile>&& value) { m_filesHasBeenSet = true; m_files = std::move(value); }
181 inline CreateOTAUpdateRequest& WithFiles(const Aws::Vector<OTAUpdateFile>& value) { SetFiles(value); return *this;}
182 inline CreateOTAUpdateRequest& WithFiles(Aws::Vector<OTAUpdateFile>&& value) { SetFiles(std::move(value)); return *this;}
183 inline CreateOTAUpdateRequest& AddFiles(const OTAUpdateFile& value) { m_filesHasBeenSet = true; m_files.push_back(value); return *this; }
184 inline CreateOTAUpdateRequest& AddFiles(OTAUpdateFile&& value) { m_filesHasBeenSet = true; m_files.push_back(std::move(value)); return *this; }
186
188
193 inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
194 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
195 inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
196 inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
197 inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
198 inline CreateOTAUpdateRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
199 inline CreateOTAUpdateRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
200 inline CreateOTAUpdateRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
202
204
208 inline const Aws::Map<Aws::String, Aws::String>& GetAdditionalParameters() const{ return m_additionalParameters; }
209 inline bool AdditionalParametersHasBeenSet() const { return m_additionalParametersHasBeenSet; }
210 inline void SetAdditionalParameters(const Aws::Map<Aws::String, Aws::String>& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters = value; }
211 inline void SetAdditionalParameters(Aws::Map<Aws::String, Aws::String>&& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters = std::move(value); }
214 inline CreateOTAUpdateRequest& AddAdditionalParameters(const Aws::String& key, const Aws::String& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(key, value); return *this; }
215 inline CreateOTAUpdateRequest& AddAdditionalParameters(Aws::String&& key, const Aws::String& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(std::move(key), value); return *this; }
216 inline CreateOTAUpdateRequest& AddAdditionalParameters(const Aws::String& key, Aws::String&& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(key, std::move(value)); return *this; }
217 inline CreateOTAUpdateRequest& AddAdditionalParameters(Aws::String&& key, Aws::String&& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(std::move(key), std::move(value)); return *this; }
218 inline CreateOTAUpdateRequest& AddAdditionalParameters(const char* key, Aws::String&& value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(key, std::move(value)); return *this; }
219 inline CreateOTAUpdateRequest& AddAdditionalParameters(Aws::String&& key, const char* value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(std::move(key), value); return *this; }
220 inline CreateOTAUpdateRequest& AddAdditionalParameters(const char* key, const char* value) { m_additionalParametersHasBeenSet = true; m_additionalParameters.emplace(key, value); return *this; }
222
224
227 inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
228 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
229 inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
230 inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
231 inline CreateOTAUpdateRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
232 inline CreateOTAUpdateRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
233 inline CreateOTAUpdateRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
234 inline CreateOTAUpdateRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
236 private:
237
238 Aws::String m_otaUpdateId;
239 bool m_otaUpdateIdHasBeenSet = false;
240
241 Aws::String m_description;
242 bool m_descriptionHasBeenSet = false;
243
244 Aws::Vector<Aws::String> m_targets;
245 bool m_targetsHasBeenSet = false;
246
247 Aws::Vector<Protocol> m_protocols;
248 bool m_protocolsHasBeenSet = false;
249
250 TargetSelection m_targetSelection;
251 bool m_targetSelectionHasBeenSet = false;
252
253 AwsJobExecutionsRolloutConfig m_awsJobExecutionsRolloutConfig;
254 bool m_awsJobExecutionsRolloutConfigHasBeenSet = false;
255
256 AwsJobPresignedUrlConfig m_awsJobPresignedUrlConfig;
257 bool m_awsJobPresignedUrlConfigHasBeenSet = false;
258
259 AwsJobAbortConfig m_awsJobAbortConfig;
260 bool m_awsJobAbortConfigHasBeenSet = false;
261
262 AwsJobTimeoutConfig m_awsJobTimeoutConfig;
263 bool m_awsJobTimeoutConfigHasBeenSet = false;
264
266 bool m_filesHasBeenSet = false;
267
268 Aws::String m_roleArn;
269 bool m_roleArnHasBeenSet = false;
270
271 Aws::Map<Aws::String, Aws::String> m_additionalParameters;
272 bool m_additionalParametersHasBeenSet = false;
273
274 Aws::Vector<Tag> m_tags;
275 bool m_tagsHasBeenSet = false;
276 };
277
278} // namespace Model
279} // namespace IoT
280} // namespace Aws
CreateOTAUpdateRequest & WithAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig &&value)
void SetAwsJobTimeoutConfig(const AwsJobTimeoutConfig &value)
CreateOTAUpdateRequest & WithRoleArn(Aws::String &&value)
CreateOTAUpdateRequest & AddAdditionalParameters(Aws::String &&key, const char *value)
CreateOTAUpdateRequest & AddAdditionalParameters(const char *key, const char *value)
void SetFiles(const Aws::Vector< OTAUpdateFile > &value)
const AwsJobExecutionsRolloutConfig & GetAwsJobExecutionsRolloutConfig() const
void SetProtocols(const Aws::Vector< Protocol > &value)
CreateOTAUpdateRequest & AddFiles(const OTAUpdateFile &value)
AWS_IOT_API Aws::String SerializePayload() const override
CreateOTAUpdateRequest & AddAdditionalParameters(const char *key, Aws::String &&value)
CreateOTAUpdateRequest & AddTargets(const Aws::String &value)
CreateOTAUpdateRequest & AddTargets(Aws::String &&value)
void SetAwsJobAbortConfig(AwsJobAbortConfig &&value)
const Aws::Vector< Protocol > & GetProtocols() const
CreateOTAUpdateRequest & AddAdditionalParameters(const Aws::String &key, Aws::String &&value)
CreateOTAUpdateRequest & WithFiles(Aws::Vector< OTAUpdateFile > &&value)
CreateOTAUpdateRequest & WithAwsJobTimeoutConfig(const AwsJobTimeoutConfig &value)
CreateOTAUpdateRequest & WithAwsJobExecutionsRolloutConfig(const AwsJobExecutionsRolloutConfig &value)
CreateOTAUpdateRequest & WithRoleArn(const char *value)
void SetAdditionalParameters(const Aws::Map< Aws::String, Aws::String > &value)
CreateOTAUpdateRequest & WithAdditionalParameters(const Aws::Map< Aws::String, Aws::String > &value)
CreateOTAUpdateRequest & WithTargets(const Aws::Vector< Aws::String > &value)
CreateOTAUpdateRequest & WithAwsJobAbortConfig(const AwsJobAbortConfig &value)
CreateOTAUpdateRequest & WithOtaUpdateId(Aws::String &&value)
CreateOTAUpdateRequest & AddTags(Tag &&value)
void SetDescription(const Aws::String &value)
CreateOTAUpdateRequest & AddTargets(const char *value)
const TargetSelection & GetTargetSelection() const
const AwsJobTimeoutConfig & GetAwsJobTimeoutConfig() const
void SetTags(const Aws::Vector< Tag > &value)
CreateOTAUpdateRequest & WithRoleArn(const Aws::String &value)
CreateOTAUpdateRequest & AddProtocols(Protocol &&value)
void SetAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig &&value)
CreateOTAUpdateRequest & WithTargetSelection(const TargetSelection &value)
CreateOTAUpdateRequest & WithAwsJobAbortConfig(AwsJobAbortConfig &&value)
void SetOtaUpdateId(const Aws::String &value)
CreateOTAUpdateRequest & WithTargets(Aws::Vector< Aws::String > &&value)
void SetFiles(Aws::Vector< OTAUpdateFile > &&value)
void SetAwsJobAbortConfig(const AwsJobAbortConfig &value)
CreateOTAUpdateRequest & AddProtocols(const Protocol &value)
CreateOTAUpdateRequest & WithProtocols(const Aws::Vector< Protocol > &value)
virtual const char * GetServiceRequestName() const override
CreateOTAUpdateRequest & AddFiles(OTAUpdateFile &&value)
CreateOTAUpdateRequest & WithAdditionalParameters(Aws::Map< Aws::String, Aws::String > &&value)
CreateOTAUpdateRequest & AddAdditionalParameters(Aws::String &&key, const Aws::String &value)
void SetTargets(Aws::Vector< Aws::String > &&value)
void SetTargetSelection(TargetSelection &&value)
CreateOTAUpdateRequest & WithDescription(const Aws::String &value)
CreateOTAUpdateRequest & WithOtaUpdateId(const char *value)
void SetProtocols(Aws::Vector< Protocol > &&value)
CreateOTAUpdateRequest & WithDescription(Aws::String &&value)
void SetAwsJobExecutionsRolloutConfig(const AwsJobExecutionsRolloutConfig &value)
CreateOTAUpdateRequest & WithAwsJobPresignedUrlConfig(const AwsJobPresignedUrlConfig &value)
CreateOTAUpdateRequest & WithDescription(const char *value)
CreateOTAUpdateRequest & WithAwsJobTimeoutConfig(AwsJobTimeoutConfig &&value)
void SetAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig &&value)
CreateOTAUpdateRequest & WithTags(const Aws::Vector< Tag > &value)
CreateOTAUpdateRequest & AddAdditionalParameters(Aws::String &&key, Aws::String &&value)
const Aws::Map< Aws::String, Aws::String > & GetAdditionalParameters() const
CreateOTAUpdateRequest & WithFiles(const Aws::Vector< OTAUpdateFile > &value)
void SetTargets(const Aws::Vector< Aws::String > &value)
void SetAwsJobPresignedUrlConfig(const AwsJobPresignedUrlConfig &value)
void SetTargetSelection(const TargetSelection &value)
CreateOTAUpdateRequest & AddAdditionalParameters(const Aws::String &key, const Aws::String &value)
void SetAdditionalParameters(Aws::Map< Aws::String, Aws::String > &&value)
const Aws::Vector< Tag > & GetTags() const
const Aws::Vector< OTAUpdateFile > & GetFiles() const
void SetAwsJobTimeoutConfig(AwsJobTimeoutConfig &&value)
void SetTags(Aws::Vector< Tag > &&value)
CreateOTAUpdateRequest & WithTargetSelection(TargetSelection &&value)
const AwsJobPresignedUrlConfig & GetAwsJobPresignedUrlConfig() const
CreateOTAUpdateRequest & WithOtaUpdateId(const Aws::String &value)
CreateOTAUpdateRequest & WithTags(Aws::Vector< Tag > &&value)
CreateOTAUpdateRequest & WithProtocols(Aws::Vector< Protocol > &&value)
const AwsJobAbortConfig & GetAwsJobAbortConfig() const
CreateOTAUpdateRequest & AddTags(const Tag &value)
const Aws::Vector< Aws::String > & GetTargets() const
CreateOTAUpdateRequest & WithAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig &&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
std::vector< T, Aws::Allocator< T > > Vector