AWS SDK for C++

AWS SDK for C++ Version 1.11.839

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/NetworkingMode.h>
15#include <aws/omics/model/RunLogLevel.h>
16#include <aws/omics/model/RunRetentionMode.h>
17#include <aws/omics/model/ScratchStorageMode.h>
18#include <aws/omics/model/StorageType.h>
19#include <aws/omics/model/WorkflowType.h>
20
21#include <utility>
22
23namespace Aws {
24namespace Omics {
25namespace Model {
26
30 public:
31 AWS_OMICS_API StartRunRequest() = default;
32
33 // Service request name is the Operation name which will send this request out,
34 // each operation should has unique request name, so that we can get operation's name from this request.
35 // Note: this is not true for response, multiple operations may have the same response name,
36 // so we can not get operation's name from response.
37 inline virtual const char* GetServiceRequestName() const override { return "StartRun"; }
38
39 AWS_OMICS_API Aws::String SerializePayload() const override;
40
42
45 inline const Aws::String& GetWorkflowId() const { return m_workflowId; }
46 inline bool WorkflowIdHasBeenSet() const { return m_workflowIdHasBeenSet; }
47 template <typename WorkflowIdT = Aws::String>
48 void SetWorkflowId(WorkflowIdT&& value) {
49 m_workflowIdHasBeenSet = true;
50 m_workflowId = std::forward<WorkflowIdT>(value);
51 }
52 template <typename WorkflowIdT = Aws::String>
53 StartRunRequest& WithWorkflowId(WorkflowIdT&& value) {
54 SetWorkflowId(std::forward<WorkflowIdT>(value));
55 return *this;
56 }
58
60
66 inline WorkflowType GetWorkflowType() const { return m_workflowType; }
67 inline bool WorkflowTypeHasBeenSet() const { return m_workflowTypeHasBeenSet; }
68 inline void SetWorkflowType(WorkflowType value) {
69 m_workflowTypeHasBeenSet = true;
70 m_workflowType = value;
71 }
73 SetWorkflowType(value);
74 return *this;
75 }
77
79
82 inline const Aws::String& GetRunId() const { return m_runId; }
83 inline bool RunIdHasBeenSet() const { return m_runIdHasBeenSet; }
84 template <typename RunIdT = Aws::String>
85 void SetRunId(RunIdT&& value) {
86 m_runIdHasBeenSet = true;
87 m_runId = std::forward<RunIdT>(value);
88 }
89 template <typename RunIdT = Aws::String>
90 StartRunRequest& WithRunId(RunIdT&& value) {
91 SetRunId(std::forward<RunIdT>(value));
92 return *this;
93 }
95
97
105 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
106 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
107 template <typename RoleArnT = Aws::String>
108 void SetRoleArn(RoleArnT&& value) {
109 m_roleArnHasBeenSet = true;
110 m_roleArn = std::forward<RoleArnT>(value);
111 }
112 template <typename RoleArnT = Aws::String>
113 StartRunRequest& WithRoleArn(RoleArnT&& value) {
114 SetRoleArn(std::forward<RoleArnT>(value));
115 return *this;
116 }
118
120
124 inline const Aws::String& GetName() const { return m_name; }
125 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
126 template <typename NameT = Aws::String>
127 void SetName(NameT&& value) {
128 m_nameHasBeenSet = true;
129 m_name = std::forward<NameT>(value);
130 }
131 template <typename NameT = Aws::String>
132 StartRunRequest& WithName(NameT&& value) {
133 SetName(std::forward<NameT>(value));
134 return *this;
135 }
137
139
143 inline const Aws::String& GetCacheId() const { return m_cacheId; }
144 inline bool CacheIdHasBeenSet() const { return m_cacheIdHasBeenSet; }
145 template <typename CacheIdT = Aws::String>
146 void SetCacheId(CacheIdT&& value) {
147 m_cacheIdHasBeenSet = true;
148 m_cacheId = std::forward<CacheIdT>(value);
149 }
150 template <typename CacheIdT = Aws::String>
151 StartRunRequest& WithCacheId(CacheIdT&& value) {
152 SetCacheId(std::forward<CacheIdT>(value));
153 return *this;
154 }
156
158
165 inline CacheBehavior GetCacheBehavior() const { return m_cacheBehavior; }
166 inline bool CacheBehaviorHasBeenSet() const { return m_cacheBehaviorHasBeenSet; }
167 inline void SetCacheBehavior(CacheBehavior value) {
168 m_cacheBehaviorHasBeenSet = true;
169 m_cacheBehavior = value;
170 }
172 SetCacheBehavior(value);
173 return *this;
174 }
176
178
182 inline const Aws::String& GetRunGroupId() const { return m_runGroupId; }
183 inline bool RunGroupIdHasBeenSet() const { return m_runGroupIdHasBeenSet; }
184 template <typename RunGroupIdT = Aws::String>
185 void SetRunGroupId(RunGroupIdT&& value) {
186 m_runGroupIdHasBeenSet = true;
187 m_runGroupId = std::forward<RunGroupIdT>(value);
188 }
189 template <typename RunGroupIdT = Aws::String>
190 StartRunRequest& WithRunGroupId(RunGroupIdT&& value) {
191 SetRunGroupId(std::forward<RunGroupIdT>(value));
192 return *this;
193 }
195
197
207 inline int GetPriority() const { return m_priority; }
208 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
209 inline void SetPriority(int value) {
210 m_priorityHasBeenSet = true;
211 m_priority = value;
212 }
213 inline StartRunRequest& WithPriority(int value) {
214 SetPriority(value);
215 return *this;
216 }
218
220
226 inline Aws::Utils::DocumentView GetParameters() const { return m_parameters; }
227 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
228 template <typename ParametersT = Aws::Utils::Document>
229 void SetParameters(ParametersT&& value) {
230 m_parametersHasBeenSet = true;
231 m_parameters = std::forward<ParametersT>(value);
232 }
233 template <typename ParametersT = Aws::Utils::Document>
234 StartRunRequest& WithParameters(ParametersT&& value) {
235 SetParameters(std::forward<ParametersT>(value));
236 return *this;
237 }
239
241
250 inline int GetStorageCapacity() const { return m_storageCapacity; }
251 inline bool StorageCapacityHasBeenSet() const { return m_storageCapacityHasBeenSet; }
252 inline void SetStorageCapacity(int value) {
253 m_storageCapacityHasBeenSet = true;
254 m_storageCapacity = value;
255 }
257 SetStorageCapacity(value);
258 return *this;
259 }
261
263
267 inline const Aws::String& GetOutputUri() const { return m_outputUri; }
268 inline bool OutputUriHasBeenSet() const { return m_outputUriHasBeenSet; }
269 template <typename OutputUriT = Aws::String>
270 void SetOutputUri(OutputUriT&& value) {
271 m_outputUriHasBeenSet = true;
272 m_outputUri = std::forward<OutputUriT>(value);
273 }
274 template <typename OutputUriT = Aws::String>
275 StartRunRequest& WithOutputUri(OutputUriT&& value) {
276 SetOutputUri(std::forward<OutputUriT>(value));
277 return *this;
278 }
280
282
285 inline RunLogLevel GetLogLevel() const { return m_logLevel; }
286 inline bool LogLevelHasBeenSet() const { return m_logLevelHasBeenSet; }
287 inline void SetLogLevel(RunLogLevel value) {
288 m_logLevelHasBeenSet = true;
289 m_logLevel = value;
290 }
292 SetLogLevel(value);
293 return *this;
294 }
296
298
303 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
304 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
305 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
306 void SetTags(TagsT&& value) {
307 m_tagsHasBeenSet = true;
308 m_tags = std::forward<TagsT>(value);
309 }
310 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
311 StartRunRequest& WithTags(TagsT&& value) {
312 SetTags(std::forward<TagsT>(value));
313 return *this;
314 }
315 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
316 StartRunRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
317 m_tagsHasBeenSet = true;
318 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
319 return *this;
320 }
322
324
328 inline const Aws::String& GetRequestId() const { return m_requestId; }
329 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
330 template <typename RequestIdT = Aws::String>
331 void SetRequestId(RequestIdT&& value) {
332 m_requestIdHasBeenSet = true;
333 m_requestId = std::forward<RequestIdT>(value);
334 }
335 template <typename RequestIdT = Aws::String>
336 StartRunRequest& WithRequestId(RequestIdT&& value) {
337 SetRequestId(std::forward<RequestIdT>(value));
338 return *this;
339 }
341
343
357 inline RunRetentionMode GetRetentionMode() const { return m_retentionMode; }
358 inline bool RetentionModeHasBeenSet() const { return m_retentionModeHasBeenSet; }
360 m_retentionModeHasBeenSet = true;
361 m_retentionMode = value;
362 }
364 SetRetentionMode(value);
365 return *this;
366 }
368
370
380 inline StorageType GetStorageType() const { return m_storageType; }
381 inline bool StorageTypeHasBeenSet() const { return m_storageTypeHasBeenSet; }
382 inline void SetStorageType(StorageType value) {
383 m_storageTypeHasBeenSet = true;
384 m_storageType = value;
385 }
387 SetStorageType(value);
388 return *this;
389 }
391
393
399 inline const Aws::String& GetWorkflowOwnerId() const { return m_workflowOwnerId; }
400 inline bool WorkflowOwnerIdHasBeenSet() const { return m_workflowOwnerIdHasBeenSet; }
401 template <typename WorkflowOwnerIdT = Aws::String>
402 void SetWorkflowOwnerId(WorkflowOwnerIdT&& value) {
403 m_workflowOwnerIdHasBeenSet = true;
404 m_workflowOwnerId = std::forward<WorkflowOwnerIdT>(value);
405 }
406 template <typename WorkflowOwnerIdT = Aws::String>
407 StartRunRequest& WithWorkflowOwnerId(WorkflowOwnerIdT&& value) {
408 SetWorkflowOwnerId(std::forward<WorkflowOwnerIdT>(value));
409 return *this;
410 }
412
414
421 inline const Aws::String& GetWorkflowVersionName() const { return m_workflowVersionName; }
422 inline bool WorkflowVersionNameHasBeenSet() const { return m_workflowVersionNameHasBeenSet; }
423 template <typename WorkflowVersionNameT = Aws::String>
424 void SetWorkflowVersionName(WorkflowVersionNameT&& value) {
425 m_workflowVersionNameHasBeenSet = true;
426 m_workflowVersionName = std::forward<WorkflowVersionNameT>(value);
427 }
428 template <typename WorkflowVersionNameT = Aws::String>
429 StartRunRequest& WithWorkflowVersionName(WorkflowVersionNameT&& value) {
430 SetWorkflowVersionName(std::forward<WorkflowVersionNameT>(value));
431 return *this;
432 }
434
436
440 inline NetworkingMode GetNetworkingMode() const { return m_networkingMode; }
441 inline bool NetworkingModeHasBeenSet() const { return m_networkingModeHasBeenSet; }
443 m_networkingModeHasBeenSet = true;
444 m_networkingMode = value;
445 }
447 SetNetworkingMode(value);
448 return *this;
449 }
451
453
459 inline ScratchStorageMode GetScratchStorageMode() const { return m_scratchStorageMode; }
460 inline bool ScratchStorageModeHasBeenSet() const { return m_scratchStorageModeHasBeenSet; }
462 m_scratchStorageModeHasBeenSet = true;
463 m_scratchStorageMode = value;
464 }
467 return *this;
468 }
470
472
475 inline const Aws::String& GetConfigurationName() const { return m_configurationName; }
476 inline bool ConfigurationNameHasBeenSet() const { return m_configurationNameHasBeenSet; }
477 template <typename ConfigurationNameT = Aws::String>
478 void SetConfigurationName(ConfigurationNameT&& value) {
479 m_configurationNameHasBeenSet = true;
480 m_configurationName = std::forward<ConfigurationNameT>(value);
481 }
482 template <typename ConfigurationNameT = Aws::String>
483 StartRunRequest& WithConfigurationName(ConfigurationNameT&& value) {
484 SetConfigurationName(std::forward<ConfigurationNameT>(value));
485 return *this;
486 }
488
490
495 inline Aws::Utils::DocumentView GetEngineSettings() const { return m_engineSettings; }
496 inline bool EngineSettingsHasBeenSet() const { return m_engineSettingsHasBeenSet; }
497 template <typename EngineSettingsT = Aws::Utils::Document>
498 void SetEngineSettings(EngineSettingsT&& value) {
499 m_engineSettingsHasBeenSet = true;
500 m_engineSettings = std::forward<EngineSettingsT>(value);
501 }
502 template <typename EngineSettingsT = Aws::Utils::Document>
503 StartRunRequest& WithEngineSettings(EngineSettingsT&& value) {
504 SetEngineSettings(std::forward<EngineSettingsT>(value));
505 return *this;
506 }
508 private:
509 Aws::String m_workflowId;
510
511 WorkflowType m_workflowType{WorkflowType::NOT_SET};
512
513 Aws::String m_runId;
514
515 Aws::String m_roleArn;
516
517 Aws::String m_name;
518
519 Aws::String m_cacheId;
520
521 CacheBehavior m_cacheBehavior{CacheBehavior::NOT_SET};
522
523 Aws::String m_runGroupId;
524
525 int m_priority{0};
526
527 Aws::Utils::Document m_parameters;
528
529 int m_storageCapacity{0};
530
531 Aws::String m_outputUri;
532
534
536
538
540
541 StorageType m_storageType{StorageType::NOT_SET};
542
543 Aws::String m_workflowOwnerId;
544
545 Aws::String m_workflowVersionName;
546
547 NetworkingMode m_networkingMode{NetworkingMode::NOT_SET};
548
550
551 Aws::String m_configurationName;
552
553 Aws::Utils::Document m_engineSettings;
554 bool m_workflowIdHasBeenSet = false;
555 bool m_workflowTypeHasBeenSet = false;
556 bool m_runIdHasBeenSet = false;
557 bool m_roleArnHasBeenSet = false;
558 bool m_nameHasBeenSet = false;
559 bool m_cacheIdHasBeenSet = false;
560 bool m_cacheBehaviorHasBeenSet = false;
561 bool m_runGroupIdHasBeenSet = false;
562 bool m_priorityHasBeenSet = false;
563 bool m_parametersHasBeenSet = false;
564 bool m_storageCapacityHasBeenSet = false;
565 bool m_outputUriHasBeenSet = false;
566 bool m_logLevelHasBeenSet = false;
567 bool m_tagsHasBeenSet = false;
568 bool m_requestIdHasBeenSet = true;
569 bool m_retentionModeHasBeenSet = false;
570 bool m_storageTypeHasBeenSet = false;
571 bool m_workflowOwnerIdHasBeenSet = false;
572 bool m_workflowVersionNameHasBeenSet = false;
573 bool m_networkingModeHasBeenSet = false;
574 bool m_scratchStorageModeHasBeenSet = false;
575 bool m_configurationNameHasBeenSet = false;
576 bool m_engineSettingsHasBeenSet = false;
577};
578
579} // namespace Model
580} // namespace Omics
581} // namespace Aws
void SetScratchStorageMode(ScratchStorageMode value)
const Aws::String & GetConfigurationName() const
Aws::Utils::DocumentView GetParameters() const
StartRunRequest & WithConfigurationName(ConfigurationNameT &&value)
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)
void SetEngineSettings(EngineSettingsT &&value)
const Aws::String & GetWorkflowVersionName() const
void SetWorkflowType(WorkflowType value)
StartRunRequest & WithNetworkingMode(NetworkingMode value)
void SetWorkflowOwnerId(WorkflowOwnerIdT &&value)
void SetNetworkingMode(NetworkingMode value)
StartRunRequest & WithWorkflowId(WorkflowIdT &&value)
const Aws::String & GetRunId() const
void SetRequestId(RequestIdT &&value)
Aws::Utils::DocumentView GetEngineSettings() const
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
ScratchStorageMode GetScratchStorageMode() const
StartRunRequest & WithRoleArn(RoleArnT &&value)
const Aws::String & GetWorkflowId() const
StartRunRequest & WithRunId(RunIdT &&value)
void SetConfigurationName(ConfigurationNameT &&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
StartRunRequest & WithEngineSettings(EngineSettingsT &&value)
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)
NetworkingMode GetNetworkingMode() const
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)
StartRunRequest & WithScratchStorageMode(ScratchStorageMode 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