AWS SDK for C++

AWS SDK for C++ Version 1.11.741

Loading...
Searching...
No Matches
StartRunRequest.h
1
6#pragma once
7#include <aws/core/utils/Document.h>
8#include <aws/core/utils/UUID.h>
9#include <aws/core/utils/memory/stl/AWSMap.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/omics/OmicsRequest.h>
12#include <aws/omics/Omics_EXPORTS.h>
13#include <aws/omics/model/CacheBehavior.h>
14#include <aws/omics/model/RunLogLevel.h>
15#include <aws/omics/model/RunRetentionMode.h>
16#include <aws/omics/model/StorageType.h>
17#include <aws/omics/model/WorkflowType.h>
18
19#include <utility>
20
21namespace Aws {
22namespace Omics {
23namespace Model {
24
28 public:
29 AWS_OMICS_API StartRunRequest() = 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 "StartRun"; }
36
37 AWS_OMICS_API Aws::String SerializePayload() const override;
38
40
43 inline const Aws::String& GetWorkflowId() const { return m_workflowId; }
44 inline bool WorkflowIdHasBeenSet() const { return m_workflowIdHasBeenSet; }
45 template <typename WorkflowIdT = Aws::String>
46 void SetWorkflowId(WorkflowIdT&& value) {
47 m_workflowIdHasBeenSet = true;
48 m_workflowId = std::forward<WorkflowIdT>(value);
49 }
50 template <typename WorkflowIdT = Aws::String>
51 StartRunRequest& WithWorkflowId(WorkflowIdT&& value) {
52 SetWorkflowId(std::forward<WorkflowIdT>(value));
53 return *this;
54 }
56
58
64 inline WorkflowType GetWorkflowType() const { return m_workflowType; }
65 inline bool WorkflowTypeHasBeenSet() const { return m_workflowTypeHasBeenSet; }
66 inline void SetWorkflowType(WorkflowType value) {
67 m_workflowTypeHasBeenSet = true;
68 m_workflowType = value;
69 }
71 SetWorkflowType(value);
72 return *this;
73 }
75
77
80 inline const Aws::String& GetRunId() const { return m_runId; }
81 inline bool RunIdHasBeenSet() const { return m_runIdHasBeenSet; }
82 template <typename RunIdT = Aws::String>
83 void SetRunId(RunIdT&& value) {
84 m_runIdHasBeenSet = true;
85 m_runId = std::forward<RunIdT>(value);
86 }
87 template <typename RunIdT = Aws::String>
88 StartRunRequest& WithRunId(RunIdT&& value) {
89 SetRunId(std::forward<RunIdT>(value));
90 return *this;
91 }
93
95
103 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
104 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
105 template <typename RoleArnT = Aws::String>
106 void SetRoleArn(RoleArnT&& value) {
107 m_roleArnHasBeenSet = true;
108 m_roleArn = std::forward<RoleArnT>(value);
109 }
110 template <typename RoleArnT = Aws::String>
111 StartRunRequest& WithRoleArn(RoleArnT&& value) {
112 SetRoleArn(std::forward<RoleArnT>(value));
113 return *this;
114 }
116
118
122 inline const Aws::String& GetName() const { return m_name; }
123 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
124 template <typename NameT = Aws::String>
125 void SetName(NameT&& value) {
126 m_nameHasBeenSet = true;
127 m_name = std::forward<NameT>(value);
128 }
129 template <typename NameT = Aws::String>
130 StartRunRequest& WithName(NameT&& value) {
131 SetName(std::forward<NameT>(value));
132 return *this;
133 }
135
137
141 inline const Aws::String& GetCacheId() const { return m_cacheId; }
142 inline bool CacheIdHasBeenSet() const { return m_cacheIdHasBeenSet; }
143 template <typename CacheIdT = Aws::String>
144 void SetCacheId(CacheIdT&& value) {
145 m_cacheIdHasBeenSet = true;
146 m_cacheId = std::forward<CacheIdT>(value);
147 }
148 template <typename CacheIdT = Aws::String>
149 StartRunRequest& WithCacheId(CacheIdT&& value) {
150 SetCacheId(std::forward<CacheIdT>(value));
151 return *this;
152 }
154
156
163 inline CacheBehavior GetCacheBehavior() const { return m_cacheBehavior; }
164 inline bool CacheBehaviorHasBeenSet() const { return m_cacheBehaviorHasBeenSet; }
165 inline void SetCacheBehavior(CacheBehavior value) {
166 m_cacheBehaviorHasBeenSet = true;
167 m_cacheBehavior = value;
168 }
170 SetCacheBehavior(value);
171 return *this;
172 }
174
176
180 inline const Aws::String& GetRunGroupId() const { return m_runGroupId; }
181 inline bool RunGroupIdHasBeenSet() const { return m_runGroupIdHasBeenSet; }
182 template <typename RunGroupIdT = Aws::String>
183 void SetRunGroupId(RunGroupIdT&& value) {
184 m_runGroupIdHasBeenSet = true;
185 m_runGroupId = std::forward<RunGroupIdT>(value);
186 }
187 template <typename RunGroupIdT = Aws::String>
188 StartRunRequest& WithRunGroupId(RunGroupIdT&& value) {
189 SetRunGroupId(std::forward<RunGroupIdT>(value));
190 return *this;
191 }
193
195
205 inline int GetPriority() const { return m_priority; }
206 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
207 inline void SetPriority(int value) {
208 m_priorityHasBeenSet = true;
209 m_priority = value;
210 }
211 inline StartRunRequest& WithPriority(int value) {
212 SetPriority(value);
213 return *this;
214 }
216
218
224 inline Aws::Utils::DocumentView GetParameters() const { return m_parameters; }
225 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
226 template <typename ParametersT = Aws::Utils::Document>
227 void SetParameters(ParametersT&& value) {
228 m_parametersHasBeenSet = true;
229 m_parameters = std::forward<ParametersT>(value);
230 }
231 template <typename ParametersT = Aws::Utils::Document>
232 StartRunRequest& WithParameters(ParametersT&& value) {
233 SetParameters(std::forward<ParametersT>(value));
234 return *this;
235 }
237
239
248 inline int GetStorageCapacity() const { return m_storageCapacity; }
249 inline bool StorageCapacityHasBeenSet() const { return m_storageCapacityHasBeenSet; }
250 inline void SetStorageCapacity(int value) {
251 m_storageCapacityHasBeenSet = true;
252 m_storageCapacity = value;
253 }
255 SetStorageCapacity(value);
256 return *this;
257 }
259
261
265 inline const Aws::String& GetOutputUri() const { return m_outputUri; }
266 inline bool OutputUriHasBeenSet() const { return m_outputUriHasBeenSet; }
267 template <typename OutputUriT = Aws::String>
268 void SetOutputUri(OutputUriT&& value) {
269 m_outputUriHasBeenSet = true;
270 m_outputUri = std::forward<OutputUriT>(value);
271 }
272 template <typename OutputUriT = Aws::String>
273 StartRunRequest& WithOutputUri(OutputUriT&& value) {
274 SetOutputUri(std::forward<OutputUriT>(value));
275 return *this;
276 }
278
280
283 inline RunLogLevel GetLogLevel() const { return m_logLevel; }
284 inline bool LogLevelHasBeenSet() const { return m_logLevelHasBeenSet; }
285 inline void SetLogLevel(RunLogLevel value) {
286 m_logLevelHasBeenSet = true;
287 m_logLevel = value;
288 }
290 SetLogLevel(value);
291 return *this;
292 }
294
296
301 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
302 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
303 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
304 void SetTags(TagsT&& value) {
305 m_tagsHasBeenSet = true;
306 m_tags = std::forward<TagsT>(value);
307 }
308 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
309 StartRunRequest& WithTags(TagsT&& value) {
310 SetTags(std::forward<TagsT>(value));
311 return *this;
312 }
313 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
314 StartRunRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
315 m_tagsHasBeenSet = true;
316 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
317 return *this;
318 }
320
322
326 inline const Aws::String& GetRequestId() const { return m_requestId; }
327 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
328 template <typename RequestIdT = Aws::String>
329 void SetRequestId(RequestIdT&& value) {
330 m_requestIdHasBeenSet = true;
331 m_requestId = std::forward<RequestIdT>(value);
332 }
333 template <typename RequestIdT = Aws::String>
334 StartRunRequest& WithRequestId(RequestIdT&& value) {
335 SetRequestId(std::forward<RequestIdT>(value));
336 return *this;
337 }
339
341
355 inline RunRetentionMode GetRetentionMode() const { return m_retentionMode; }
356 inline bool RetentionModeHasBeenSet() const { return m_retentionModeHasBeenSet; }
358 m_retentionModeHasBeenSet = true;
359 m_retentionMode = value;
360 }
362 SetRetentionMode(value);
363 return *this;
364 }
366
368
378 inline StorageType GetStorageType() const { return m_storageType; }
379 inline bool StorageTypeHasBeenSet() const { return m_storageTypeHasBeenSet; }
380 inline void SetStorageType(StorageType value) {
381 m_storageTypeHasBeenSet = true;
382 m_storageType = value;
383 }
385 SetStorageType(value);
386 return *this;
387 }
389
391
397 inline const Aws::String& GetWorkflowOwnerId() const { return m_workflowOwnerId; }
398 inline bool WorkflowOwnerIdHasBeenSet() const { return m_workflowOwnerIdHasBeenSet; }
399 template <typename WorkflowOwnerIdT = Aws::String>
400 void SetWorkflowOwnerId(WorkflowOwnerIdT&& value) {
401 m_workflowOwnerIdHasBeenSet = true;
402 m_workflowOwnerId = std::forward<WorkflowOwnerIdT>(value);
403 }
404 template <typename WorkflowOwnerIdT = Aws::String>
405 StartRunRequest& WithWorkflowOwnerId(WorkflowOwnerIdT&& value) {
406 SetWorkflowOwnerId(std::forward<WorkflowOwnerIdT>(value));
407 return *this;
408 }
410
412
419 inline const Aws::String& GetWorkflowVersionName() const { return m_workflowVersionName; }
420 inline bool WorkflowVersionNameHasBeenSet() const { return m_workflowVersionNameHasBeenSet; }
421 template <typename WorkflowVersionNameT = Aws::String>
422 void SetWorkflowVersionName(WorkflowVersionNameT&& value) {
423 m_workflowVersionNameHasBeenSet = true;
424 m_workflowVersionName = std::forward<WorkflowVersionNameT>(value);
425 }
426 template <typename WorkflowVersionNameT = Aws::String>
427 StartRunRequest& WithWorkflowVersionName(WorkflowVersionNameT&& value) {
428 SetWorkflowVersionName(std::forward<WorkflowVersionNameT>(value));
429 return *this;
430 }
432 private:
433 Aws::String m_workflowId;
434
435 WorkflowType m_workflowType{WorkflowType::NOT_SET};
436
437 Aws::String m_runId;
438
439 Aws::String m_roleArn;
440
441 Aws::String m_name;
442
443 Aws::String m_cacheId;
444
445 CacheBehavior m_cacheBehavior{CacheBehavior::NOT_SET};
446
447 Aws::String m_runGroupId;
448
449 int m_priority{0};
450
451 Aws::Utils::Document m_parameters;
452
453 int m_storageCapacity{0};
454
455 Aws::String m_outputUri;
456
458
460
462
464
465 StorageType m_storageType{StorageType::NOT_SET};
466
467 Aws::String m_workflowOwnerId;
468
469 Aws::String m_workflowVersionName;
470 bool m_workflowIdHasBeenSet = false;
471 bool m_workflowTypeHasBeenSet = false;
472 bool m_runIdHasBeenSet = false;
473 bool m_roleArnHasBeenSet = false;
474 bool m_nameHasBeenSet = false;
475 bool m_cacheIdHasBeenSet = false;
476 bool m_cacheBehaviorHasBeenSet = false;
477 bool m_runGroupIdHasBeenSet = false;
478 bool m_priorityHasBeenSet = false;
479 bool m_parametersHasBeenSet = false;
480 bool m_storageCapacityHasBeenSet = false;
481 bool m_outputUriHasBeenSet = false;
482 bool m_logLevelHasBeenSet = false;
483 bool m_tagsHasBeenSet = false;
484 bool m_requestIdHasBeenSet = true;
485 bool m_retentionModeHasBeenSet = false;
486 bool m_storageTypeHasBeenSet = false;
487 bool m_workflowOwnerIdHasBeenSet = false;
488 bool m_workflowVersionNameHasBeenSet = false;
489};
490
491} // namespace Model
492} // namespace Omics
493} // namespace Aws
Aws::Utils::DocumentView GetParameters() const
AWS_OMICS_API Aws::String SerializePayload() const override
StartRunRequest & WithTags(TagsT &&value)
const Aws::String & GetWorkflowOwnerId() const
StartRunRequest & WithRetentionMode(RunRetentionMode value)
void SetOutputUri(OutputUriT &&value)
StartRunRequest & WithCacheId(CacheIdT &&value)
const Aws::String & GetWorkflowVersionName() const
void SetWorkflowType(WorkflowType value)
void SetWorkflowOwnerId(WorkflowOwnerIdT &&value)
StartRunRequest & WithWorkflowId(WorkflowIdT &&value)
const Aws::String & GetRunId() const
void SetRequestId(RequestIdT &&value)
void SetCacheBehavior(CacheBehavior value)
StartRunRequest & WithRunGroupId(RunGroupIdT &&value)
const Aws::String & GetRunGroupId() const
StartRunRequest & WithWorkflowOwnerId(WorkflowOwnerIdT &&value)
void SetWorkflowVersionName(WorkflowVersionNameT &&value)
const Aws::String & GetRoleArn() const
CacheBehavior GetCacheBehavior() const
StartRunRequest & WithRoleArn(RoleArnT &&value)
const Aws::String & GetWorkflowId() const
StartRunRequest & WithRunId(RunIdT &&value)
void SetRunGroupId(RunGroupIdT &&value)
StartRunRequest & WithParameters(ParametersT &&value)
StartRunRequest & WithLogLevel(RunLogLevel value)
const Aws::String & GetCacheId() const
StartRunRequest & WithWorkflowType(WorkflowType value)
StartRunRequest & AddTags(TagsKeyT &&key, TagsValueT &&value)
const Aws::String & GetRequestId() const
const Aws::Map< Aws::String, Aws::String > & GetTags() const
RunRetentionMode GetRetentionMode() const
const Aws::String & GetOutputUri() const
void SetRetentionMode(RunRetentionMode value)
void SetWorkflowId(WorkflowIdT &&value)
const Aws::String & GetName() const
StartRunRequest & WithName(NameT &&value)
StartRunRequest & WithWorkflowVersionName(WorkflowVersionNameT &&value)
StartRunRequest & WithStorageCapacity(int value)
StartRunRequest & WithPriority(int value)
StartRunRequest & WithStorageType(StorageType value)
void SetParameters(ParametersT &&value)
StartRunRequest & WithCacheBehavior(CacheBehavior value)
void SetStorageType(StorageType value)
StartRunRequest & WithRequestId(RequestIdT &&value)
virtual const char * GetServiceRequestName() const override
StartRunRequest & WithOutputUri(OutputUriT &&value)
AWS_OMICS_API StartRunRequest()=default
void SetLogLevel(RunLogLevel 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