AWS SDK for C++

AWS SDK for C++ Version 1.11.891

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
106 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
107 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
108 template <typename RoleArnT = Aws::String>
109 void SetRoleArn(RoleArnT&& value) {
110 m_roleArnHasBeenSet = true;
111 m_roleArn = std::forward<RoleArnT>(value);
112 }
113 template <typename RoleArnT = Aws::String>
114 StartRunRequest& WithRoleArn(RoleArnT&& value) {
115 SetRoleArn(std::forward<RoleArnT>(value));
116 return *this;
117 }
119
121
125 inline const Aws::String& GetName() const { return m_name; }
126 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
127 template <typename NameT = Aws::String>
128 void SetName(NameT&& value) {
129 m_nameHasBeenSet = true;
130 m_name = std::forward<NameT>(value);
131 }
132 template <typename NameT = Aws::String>
133 StartRunRequest& WithName(NameT&& value) {
134 SetName(std::forward<NameT>(value));
135 return *this;
136 }
138
140
144 inline const Aws::String& GetCacheId() const { return m_cacheId; }
145 inline bool CacheIdHasBeenSet() const { return m_cacheIdHasBeenSet; }
146 template <typename CacheIdT = Aws::String>
147 void SetCacheId(CacheIdT&& value) {
148 m_cacheIdHasBeenSet = true;
149 m_cacheId = std::forward<CacheIdT>(value);
150 }
151 template <typename CacheIdT = Aws::String>
152 StartRunRequest& WithCacheId(CacheIdT&& value) {
153 SetCacheId(std::forward<CacheIdT>(value));
154 return *this;
155 }
157
159
166 inline CacheBehavior GetCacheBehavior() const { return m_cacheBehavior; }
167 inline bool CacheBehaviorHasBeenSet() const { return m_cacheBehaviorHasBeenSet; }
168 inline void SetCacheBehavior(CacheBehavior value) {
169 m_cacheBehaviorHasBeenSet = true;
170 m_cacheBehavior = value;
171 }
173 SetCacheBehavior(value);
174 return *this;
175 }
177
179
183 inline const Aws::String& GetRunGroupId() const { return m_runGroupId; }
184 inline bool RunGroupIdHasBeenSet() const { return m_runGroupIdHasBeenSet; }
185 template <typename RunGroupIdT = Aws::String>
186 void SetRunGroupId(RunGroupIdT&& value) {
187 m_runGroupIdHasBeenSet = true;
188 m_runGroupId = std::forward<RunGroupIdT>(value);
189 }
190 template <typename RunGroupIdT = Aws::String>
191 StartRunRequest& WithRunGroupId(RunGroupIdT&& value) {
192 SetRunGroupId(std::forward<RunGroupIdT>(value));
193 return *this;
194 }
196
198
208 inline int GetPriority() const { return m_priority; }
209 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
210 inline void SetPriority(int value) {
211 m_priorityHasBeenSet = true;
212 m_priority = value;
213 }
214 inline StartRunRequest& WithPriority(int value) {
215 SetPriority(value);
216 return *this;
217 }
219
221
227 inline Aws::Utils::DocumentView GetParameters() const { return m_parameters; }
228 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
229 template <typename ParametersT = Aws::Utils::Document>
230 void SetParameters(ParametersT&& value) {
231 m_parametersHasBeenSet = true;
232 m_parameters = std::forward<ParametersT>(value);
233 }
234 template <typename ParametersT = Aws::Utils::Document>
235 StartRunRequest& WithParameters(ParametersT&& value) {
236 SetParameters(std::forward<ParametersT>(value));
237 return *this;
238 }
240
242
251 inline int GetStorageCapacity() const { return m_storageCapacity; }
252 inline bool StorageCapacityHasBeenSet() const { return m_storageCapacityHasBeenSet; }
253 inline void SetStorageCapacity(int value) {
254 m_storageCapacityHasBeenSet = true;
255 m_storageCapacity = value;
256 }
258 SetStorageCapacity(value);
259 return *this;
260 }
262
264
268 inline const Aws::String& GetOutputUri() const { return m_outputUri; }
269 inline bool OutputUriHasBeenSet() const { return m_outputUriHasBeenSet; }
270 template <typename OutputUriT = Aws::String>
271 void SetOutputUri(OutputUriT&& value) {
272 m_outputUriHasBeenSet = true;
273 m_outputUri = std::forward<OutputUriT>(value);
274 }
275 template <typename OutputUriT = Aws::String>
276 StartRunRequest& WithOutputUri(OutputUriT&& value) {
277 SetOutputUri(std::forward<OutputUriT>(value));
278 return *this;
279 }
281
283
286 inline RunLogLevel GetLogLevel() const { return m_logLevel; }
287 inline bool LogLevelHasBeenSet() const { return m_logLevelHasBeenSet; }
288 inline void SetLogLevel(RunLogLevel value) {
289 m_logLevelHasBeenSet = true;
290 m_logLevel = value;
291 }
293 SetLogLevel(value);
294 return *this;
295 }
297
299
304 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
305 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
306 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
307 void SetTags(TagsT&& value) {
308 m_tagsHasBeenSet = true;
309 m_tags = std::forward<TagsT>(value);
310 }
311 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
312 StartRunRequest& WithTags(TagsT&& value) {
313 SetTags(std::forward<TagsT>(value));
314 return *this;
315 }
316 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
317 StartRunRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
318 m_tagsHasBeenSet = true;
319 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
320 return *this;
321 }
323
325
329 inline const Aws::String& GetRequestId() const { return m_requestId; }
330 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
331 template <typename RequestIdT = Aws::String>
332 void SetRequestId(RequestIdT&& value) {
333 m_requestIdHasBeenSet = true;
334 m_requestId = std::forward<RequestIdT>(value);
335 }
336 template <typename RequestIdT = Aws::String>
337 StartRunRequest& WithRequestId(RequestIdT&& value) {
338 SetRequestId(std::forward<RequestIdT>(value));
339 return *this;
340 }
342
344
358 inline RunRetentionMode GetRetentionMode() const { return m_retentionMode; }
359 inline bool RetentionModeHasBeenSet() const { return m_retentionModeHasBeenSet; }
361 m_retentionModeHasBeenSet = true;
362 m_retentionMode = value;
363 }
365 SetRetentionMode(value);
366 return *this;
367 }
369
371
381 inline StorageType GetStorageType() const { return m_storageType; }
382 inline bool StorageTypeHasBeenSet() const { return m_storageTypeHasBeenSet; }
383 inline void SetStorageType(StorageType value) {
384 m_storageTypeHasBeenSet = true;
385 m_storageType = value;
386 }
388 SetStorageType(value);
389 return *this;
390 }
392
394
400 inline const Aws::String& GetWorkflowOwnerId() const { return m_workflowOwnerId; }
401 inline bool WorkflowOwnerIdHasBeenSet() const { return m_workflowOwnerIdHasBeenSet; }
402 template <typename WorkflowOwnerIdT = Aws::String>
403 void SetWorkflowOwnerId(WorkflowOwnerIdT&& value) {
404 m_workflowOwnerIdHasBeenSet = true;
405 m_workflowOwnerId = std::forward<WorkflowOwnerIdT>(value);
406 }
407 template <typename WorkflowOwnerIdT = Aws::String>
408 StartRunRequest& WithWorkflowOwnerId(WorkflowOwnerIdT&& value) {
409 SetWorkflowOwnerId(std::forward<WorkflowOwnerIdT>(value));
410 return *this;
411 }
413
415
422 inline const Aws::String& GetWorkflowVersionName() const { return m_workflowVersionName; }
423 inline bool WorkflowVersionNameHasBeenSet() const { return m_workflowVersionNameHasBeenSet; }
424 template <typename WorkflowVersionNameT = Aws::String>
425 void SetWorkflowVersionName(WorkflowVersionNameT&& value) {
426 m_workflowVersionNameHasBeenSet = true;
427 m_workflowVersionName = std::forward<WorkflowVersionNameT>(value);
428 }
429 template <typename WorkflowVersionNameT = Aws::String>
430 StartRunRequest& WithWorkflowVersionName(WorkflowVersionNameT&& value) {
431 SetWorkflowVersionName(std::forward<WorkflowVersionNameT>(value));
432 return *this;
433 }
435
437
441 inline NetworkingMode GetNetworkingMode() const { return m_networkingMode; }
442 inline bool NetworkingModeHasBeenSet() const { return m_networkingModeHasBeenSet; }
444 m_networkingModeHasBeenSet = true;
445 m_networkingMode = value;
446 }
448 SetNetworkingMode(value);
449 return *this;
450 }
452
454
460 inline ScratchStorageMode GetScratchStorageMode() const { return m_scratchStorageMode; }
461 inline bool ScratchStorageModeHasBeenSet() const { return m_scratchStorageModeHasBeenSet; }
463 m_scratchStorageModeHasBeenSet = true;
464 m_scratchStorageMode = value;
465 }
468 return *this;
469 }
471
473
476 inline const Aws::String& GetConfigurationName() const { return m_configurationName; }
477 inline bool ConfigurationNameHasBeenSet() const { return m_configurationNameHasBeenSet; }
478 template <typename ConfigurationNameT = Aws::String>
479 void SetConfigurationName(ConfigurationNameT&& value) {
480 m_configurationNameHasBeenSet = true;
481 m_configurationName = std::forward<ConfigurationNameT>(value);
482 }
483 template <typename ConfigurationNameT = Aws::String>
484 StartRunRequest& WithConfigurationName(ConfigurationNameT&& value) {
485 SetConfigurationName(std::forward<ConfigurationNameT>(value));
486 return *this;
487 }
489
491
495 inline const Aws::String& GetSessionPolicy() const { return m_sessionPolicy; }
496 inline bool SessionPolicyHasBeenSet() const { return m_sessionPolicyHasBeenSet; }
497 template <typename SessionPolicyT = Aws::String>
498 void SetSessionPolicy(SessionPolicyT&& value) {
499 m_sessionPolicyHasBeenSet = true;
500 m_sessionPolicy = std::forward<SessionPolicyT>(value);
501 }
502 template <typename SessionPolicyT = Aws::String>
503 StartRunRequest& WithSessionPolicy(SessionPolicyT&& value) {
504 SetSessionPolicy(std::forward<SessionPolicyT>(value));
505 return *this;
506 }
508
510
515 inline Aws::Utils::DocumentView GetEngineSettings() const { return m_engineSettings; }
516 inline bool EngineSettingsHasBeenSet() const { return m_engineSettingsHasBeenSet; }
517 template <typename EngineSettingsT = Aws::Utils::Document>
518 void SetEngineSettings(EngineSettingsT&& value) {
519 m_engineSettingsHasBeenSet = true;
520 m_engineSettings = std::forward<EngineSettingsT>(value);
521 }
522 template <typename EngineSettingsT = Aws::Utils::Document>
523 StartRunRequest& WithEngineSettings(EngineSettingsT&& value) {
524 SetEngineSettings(std::forward<EngineSettingsT>(value));
525 return *this;
526 }
528 private:
529 Aws::String m_workflowId;
530
531 WorkflowType m_workflowType{WorkflowType::NOT_SET};
532
533 Aws::String m_runId;
534
535 Aws::String m_roleArn;
536
537 Aws::String m_name;
538
539 Aws::String m_cacheId;
540
541 CacheBehavior m_cacheBehavior{CacheBehavior::NOT_SET};
542
543 Aws::String m_runGroupId;
544
545 int m_priority{0};
546
547 Aws::Utils::Document m_parameters;
548
549 int m_storageCapacity{0};
550
551 Aws::String m_outputUri;
552
554
556
558
560
561 StorageType m_storageType{StorageType::NOT_SET};
562
563 Aws::String m_workflowOwnerId;
564
565 Aws::String m_workflowVersionName;
566
567 NetworkingMode m_networkingMode{NetworkingMode::NOT_SET};
568
570
571 Aws::String m_configurationName;
572
573 Aws::String m_sessionPolicy;
574
575 Aws::Utils::Document m_engineSettings;
576 bool m_workflowIdHasBeenSet = false;
577 bool m_workflowTypeHasBeenSet = false;
578 bool m_runIdHasBeenSet = false;
579 bool m_roleArnHasBeenSet = false;
580 bool m_nameHasBeenSet = false;
581 bool m_cacheIdHasBeenSet = false;
582 bool m_cacheBehaviorHasBeenSet = false;
583 bool m_runGroupIdHasBeenSet = false;
584 bool m_priorityHasBeenSet = false;
585 bool m_parametersHasBeenSet = false;
586 bool m_storageCapacityHasBeenSet = false;
587 bool m_outputUriHasBeenSet = false;
588 bool m_logLevelHasBeenSet = false;
589 bool m_tagsHasBeenSet = false;
590 bool m_requestIdHasBeenSet = true;
591 bool m_retentionModeHasBeenSet = false;
592 bool m_storageTypeHasBeenSet = false;
593 bool m_workflowOwnerIdHasBeenSet = false;
594 bool m_workflowVersionNameHasBeenSet = false;
595 bool m_networkingModeHasBeenSet = false;
596 bool m_scratchStorageModeHasBeenSet = false;
597 bool m_configurationNameHasBeenSet = false;
598 bool m_sessionPolicyHasBeenSet = false;
599 bool m_engineSettingsHasBeenSet = false;
600};
601
602} // namespace Model
603} // namespace Omics
604} // 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 & WithSessionPolicy(SessionPolicyT &&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
const Aws::String & GetSessionPolicy() const
StartRunRequest & WithRoleArn(RoleArnT &&value)
const Aws::String & GetWorkflowId() const
StartRunRequest & WithRunId(RunIdT &&value)
void SetConfigurationName(ConfigurationNameT &&value)
void SetRunGroupId(RunGroupIdT &&value)
void SetSessionPolicy(SessionPolicyT &&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