AWS SDK for C++

AWS SDK for C++ Version 1.11.612

Loading...
Searching...
No Matches
CreateOtaTaskRequest.h
1
6#pragma once
7#include <aws/iot-managed-integrations/IoTManagedIntegrations_EXPORTS.h>
8#include <aws/iot-managed-integrations/IoTManagedIntegrationsRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/iot-managed-integrations/model/OtaProtocol.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/iot-managed-integrations/model/OtaMechanism.h>
13#include <aws/iot-managed-integrations/model/OtaType.h>
14#include <aws/iot-managed-integrations/model/OtaTaskSchedulingConfig.h>
15#include <aws/iot-managed-integrations/model/OtaTaskExecutionRetryConfig.h>
16#include <aws/core/utils/memory/stl/AWSMap.h>
17#include <utility>
18#include <aws/core/utils/UUID.h>
19
20namespace Aws
21{
22namespace IoTManagedIntegrations
23{
24namespace Model
25{
26
30 {
31 public:
32 AWS_IOTMANAGEDINTEGRATIONS_API CreateOtaTaskRequest() = default;
33
34 // Service request name is the Operation name which will send this request out,
35 // each operation should has unique request name, so that we can get operation's name from this request.
36 // Note: this is not true for response, multiple operations may have the same response name,
37 // so we can not get operation's name from response.
38 inline virtual const char* GetServiceRequestName() const override { return "CreateOtaTask"; }
39
40 AWS_IOTMANAGEDINTEGRATIONS_API Aws::String SerializePayload() const override;
41
42
44
47 inline const Aws::String& GetDescription() const { return m_description; }
48 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
49 template<typename DescriptionT = Aws::String>
50 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
51 template<typename DescriptionT = Aws::String>
52 CreateOtaTaskRequest& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
54
56
60 inline const Aws::String& GetS3Url() const { return m_s3Url; }
61 inline bool S3UrlHasBeenSet() const { return m_s3UrlHasBeenSet; }
62 template<typename S3UrlT = Aws::String>
63 void SetS3Url(S3UrlT&& value) { m_s3UrlHasBeenSet = true; m_s3Url = std::forward<S3UrlT>(value); }
64 template<typename S3UrlT = Aws::String>
65 CreateOtaTaskRequest& WithS3Url(S3UrlT&& value) { SetS3Url(std::forward<S3UrlT>(value)); return *this;}
67
69
73 inline OtaProtocol GetProtocol() const { return m_protocol; }
74 inline bool ProtocolHasBeenSet() const { return m_protocolHasBeenSet; }
75 inline void SetProtocol(OtaProtocol value) { m_protocolHasBeenSet = true; m_protocol = value; }
76 inline CreateOtaTaskRequest& WithProtocol(OtaProtocol value) { SetProtocol(value); return *this;}
78
80
83 inline const Aws::Vector<Aws::String>& GetTarget() const { return m_target; }
84 inline bool TargetHasBeenSet() const { return m_targetHasBeenSet; }
85 template<typename TargetT = Aws::Vector<Aws::String>>
86 void SetTarget(TargetT&& value) { m_targetHasBeenSet = true; m_target = std::forward<TargetT>(value); }
87 template<typename TargetT = Aws::Vector<Aws::String>>
88 CreateOtaTaskRequest& WithTarget(TargetT&& value) { SetTarget(std::forward<TargetT>(value)); return *this;}
89 template<typename TargetT = Aws::String>
90 CreateOtaTaskRequest& AddTarget(TargetT&& value) { m_targetHasBeenSet = true; m_target.emplace_back(std::forward<TargetT>(value)); return *this; }
92
94
97 inline const Aws::String& GetTaskConfigurationId() const { return m_taskConfigurationId; }
98 inline bool TaskConfigurationIdHasBeenSet() const { return m_taskConfigurationIdHasBeenSet; }
99 template<typename TaskConfigurationIdT = Aws::String>
100 void SetTaskConfigurationId(TaskConfigurationIdT&& value) { m_taskConfigurationIdHasBeenSet = true; m_taskConfigurationId = std::forward<TaskConfigurationIdT>(value); }
101 template<typename TaskConfigurationIdT = Aws::String>
102 CreateOtaTaskRequest& WithTaskConfigurationId(TaskConfigurationIdT&& value) { SetTaskConfigurationId(std::forward<TaskConfigurationIdT>(value)); return *this;}
104
106
109 inline OtaMechanism GetOtaMechanism() const { return m_otaMechanism; }
110 inline bool OtaMechanismHasBeenSet() const { return m_otaMechanismHasBeenSet; }
111 inline void SetOtaMechanism(OtaMechanism value) { m_otaMechanismHasBeenSet = true; m_otaMechanism = value; }
114
116
119 inline OtaType GetOtaType() const { return m_otaType; }
120 inline bool OtaTypeHasBeenSet() const { return m_otaTypeHasBeenSet; }
121 inline void SetOtaType(OtaType value) { m_otaTypeHasBeenSet = true; m_otaType = value; }
122 inline CreateOtaTaskRequest& WithOtaType(OtaType value) { SetOtaType(value); return *this;}
124
126
129 inline const Aws::String& GetOtaTargetQueryString() const { return m_otaTargetQueryString; }
130 inline bool OtaTargetQueryStringHasBeenSet() const { return m_otaTargetQueryStringHasBeenSet; }
131 template<typename OtaTargetQueryStringT = Aws::String>
132 void SetOtaTargetQueryString(OtaTargetQueryStringT&& value) { m_otaTargetQueryStringHasBeenSet = true; m_otaTargetQueryString = std::forward<OtaTargetQueryStringT>(value); }
133 template<typename OtaTargetQueryStringT = Aws::String>
134 CreateOtaTaskRequest& WithOtaTargetQueryString(OtaTargetQueryStringT&& value) { SetOtaTargetQueryString(std::forward<OtaTargetQueryStringT>(value)); return *this;}
136
138
143 inline const Aws::String& GetClientToken() const { return m_clientToken; }
144 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
145 template<typename ClientTokenT = Aws::String>
146 void SetClientToken(ClientTokenT&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::forward<ClientTokenT>(value); }
147 template<typename ClientTokenT = Aws::String>
148 CreateOtaTaskRequest& WithClientToken(ClientTokenT&& value) { SetClientToken(std::forward<ClientTokenT>(value)); return *this;}
150
152
153 inline const OtaTaskSchedulingConfig& GetOtaSchedulingConfig() const { return m_otaSchedulingConfig; }
154 inline bool OtaSchedulingConfigHasBeenSet() const { return m_otaSchedulingConfigHasBeenSet; }
155 template<typename OtaSchedulingConfigT = OtaTaskSchedulingConfig>
156 void SetOtaSchedulingConfig(OtaSchedulingConfigT&& value) { m_otaSchedulingConfigHasBeenSet = true; m_otaSchedulingConfig = std::forward<OtaSchedulingConfigT>(value); }
157 template<typename OtaSchedulingConfigT = OtaTaskSchedulingConfig>
158 CreateOtaTaskRequest& WithOtaSchedulingConfig(OtaSchedulingConfigT&& value) { SetOtaSchedulingConfig(std::forward<OtaSchedulingConfigT>(value)); return *this;}
160
162
163 inline const OtaTaskExecutionRetryConfig& GetOtaTaskExecutionRetryConfig() const { return m_otaTaskExecutionRetryConfig; }
164 inline bool OtaTaskExecutionRetryConfigHasBeenSet() const { return m_otaTaskExecutionRetryConfigHasBeenSet; }
165 template<typename OtaTaskExecutionRetryConfigT = OtaTaskExecutionRetryConfig>
166 void SetOtaTaskExecutionRetryConfig(OtaTaskExecutionRetryConfigT&& value) { m_otaTaskExecutionRetryConfigHasBeenSet = true; m_otaTaskExecutionRetryConfig = std::forward<OtaTaskExecutionRetryConfigT>(value); }
167 template<typename OtaTaskExecutionRetryConfigT = OtaTaskExecutionRetryConfig>
168 CreateOtaTaskRequest& WithOtaTaskExecutionRetryConfig(OtaTaskExecutionRetryConfigT&& value) { SetOtaTaskExecutionRetryConfig(std::forward<OtaTaskExecutionRetryConfigT>(value)); return *this;}
170
172
176 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
177 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
178 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
179 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
180 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
181 CreateOtaTaskRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
182 template<typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
183 CreateOtaTaskRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
184 m_tagsHasBeenSet = true; m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value)); return *this;
185 }
187 private:
188
189 Aws::String m_description;
190 bool m_descriptionHasBeenSet = false;
191
192 Aws::String m_s3Url;
193 bool m_s3UrlHasBeenSet = false;
194
196 bool m_protocolHasBeenSet = false;
197
199 bool m_targetHasBeenSet = false;
200
201 Aws::String m_taskConfigurationId;
202 bool m_taskConfigurationIdHasBeenSet = false;
203
204 OtaMechanism m_otaMechanism{OtaMechanism::NOT_SET};
205 bool m_otaMechanismHasBeenSet = false;
206
207 OtaType m_otaType{OtaType::NOT_SET};
208 bool m_otaTypeHasBeenSet = false;
209
210 Aws::String m_otaTargetQueryString;
211 bool m_otaTargetQueryStringHasBeenSet = false;
212
214 bool m_clientTokenHasBeenSet = true;
215
216 OtaTaskSchedulingConfig m_otaSchedulingConfig;
217 bool m_otaSchedulingConfigHasBeenSet = false;
218
219 OtaTaskExecutionRetryConfig m_otaTaskExecutionRetryConfig;
220 bool m_otaTaskExecutionRetryConfigHasBeenSet = false;
221
223 bool m_tagsHasBeenSet = false;
224 };
225
226} // namespace Model
227} // namespace IoTManagedIntegrations
228} // namespace Aws
void SetOtaTaskExecutionRetryConfig(OtaTaskExecutionRetryConfigT &&value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
CreateOtaTaskRequest & WithOtaTargetQueryString(OtaTargetQueryStringT &&value)
CreateOtaTaskRequest & WithProtocol(OtaProtocol value)
AWS_IOTMANAGEDINTEGRATIONS_API CreateOtaTaskRequest()=default
virtual const char * GetServiceRequestName() const override
CreateOtaTaskRequest & WithOtaTaskExecutionRetryConfig(OtaTaskExecutionRetryConfigT &&value)
const Aws::Vector< Aws::String > & GetTarget() const
const OtaTaskSchedulingConfig & GetOtaSchedulingConfig() const
CreateOtaTaskRequest & WithClientToken(ClientTokenT &&value)
CreateOtaTaskRequest & WithOtaMechanism(OtaMechanism value)
AWS_IOTMANAGEDINTEGRATIONS_API Aws::String SerializePayload() const override
CreateOtaTaskRequest & WithDescription(DescriptionT &&value)
CreateOtaTaskRequest & WithOtaSchedulingConfig(OtaSchedulingConfigT &&value)
CreateOtaTaskRequest & AddTags(TagsKeyT &&key, TagsValueT &&value)
const OtaTaskExecutionRetryConfig & GetOtaTaskExecutionRetryConfig() const
CreateOtaTaskRequest & WithTaskConfigurationId(TaskConfigurationIdT &&value)
static Aws::Utils::UUID PseudoRandomUUID()
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