AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
StartRunRequest.h
1
6#pragma once
7#include <aws/omics/Omics_EXPORTS.h>
8#include <aws/omics/OmicsRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/omics/model/WorkflowType.h>
11#include <aws/omics/model/CacheBehavior.h>
12#include <aws/core/utils/Document.h>
13#include <aws/omics/model/RunLogLevel.h>
14#include <aws/core/utils/memory/stl/AWSMap.h>
15#include <aws/omics/model/RunRetentionMode.h>
16#include <aws/omics/model/StorageType.h>
17#include <utility>
18#include <aws/core/utils/UUID.h>
19
20namespace Aws
21{
22namespace Omics
23{
24namespace Model
25{
26
30 {
31 public:
32 AWS_OMICS_API StartRunRequest() = 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 "StartRun"; }
39
40 AWS_OMICS_API Aws::String SerializePayload() const override;
41
42
44
47 inline const Aws::String& GetWorkflowId() const { return m_workflowId; }
48 inline bool WorkflowIdHasBeenSet() const { return m_workflowIdHasBeenSet; }
49 template<typename WorkflowIdT = Aws::String>
50 void SetWorkflowId(WorkflowIdT&& value) { m_workflowIdHasBeenSet = true; m_workflowId = std::forward<WorkflowIdT>(value); }
51 template<typename WorkflowIdT = Aws::String>
52 StartRunRequest& WithWorkflowId(WorkflowIdT&& value) { SetWorkflowId(std::forward<WorkflowIdT>(value)); return *this;}
54
56
59 inline WorkflowType GetWorkflowType() const { return m_workflowType; }
60 inline bool WorkflowTypeHasBeenSet() const { return m_workflowTypeHasBeenSet; }
61 inline void SetWorkflowType(WorkflowType value) { m_workflowTypeHasBeenSet = true; m_workflowType = value; }
62 inline StartRunRequest& WithWorkflowType(WorkflowType value) { SetWorkflowType(value); return *this;}
64
66
69 inline const Aws::String& GetRunId() const { return m_runId; }
70 inline bool RunIdHasBeenSet() const { return m_runIdHasBeenSet; }
71 template<typename RunIdT = Aws::String>
72 void SetRunId(RunIdT&& value) { m_runIdHasBeenSet = true; m_runId = std::forward<RunIdT>(value); }
73 template<typename RunIdT = Aws::String>
74 StartRunRequest& WithRunId(RunIdT&& value) { SetRunId(std::forward<RunIdT>(value)); return *this;}
76
78
81 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
82 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
83 template<typename RoleArnT = Aws::String>
84 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
85 template<typename RoleArnT = Aws::String>
86 StartRunRequest& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
88
90
93 inline const Aws::String& GetName() const { return m_name; }
94 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
95 template<typename NameT = Aws::String>
96 void SetName(NameT&& value) { m_nameHasBeenSet = true; m_name = std::forward<NameT>(value); }
97 template<typename NameT = Aws::String>
98 StartRunRequest& WithName(NameT&& value) { SetName(std::forward<NameT>(value)); return *this;}
100
102
106 inline const Aws::String& GetCacheId() const { return m_cacheId; }
107 inline bool CacheIdHasBeenSet() const { return m_cacheIdHasBeenSet; }
108 template<typename CacheIdT = Aws::String>
109 void SetCacheId(CacheIdT&& value) { m_cacheIdHasBeenSet = true; m_cacheId = std::forward<CacheIdT>(value); }
110 template<typename CacheIdT = Aws::String>
111 StartRunRequest& WithCacheId(CacheIdT&& value) { SetCacheId(std::forward<CacheIdT>(value)); return *this;}
113
115
122 inline CacheBehavior GetCacheBehavior() const { return m_cacheBehavior; }
123 inline bool CacheBehaviorHasBeenSet() const { return m_cacheBehaviorHasBeenSet; }
124 inline void SetCacheBehavior(CacheBehavior value) { m_cacheBehaviorHasBeenSet = true; m_cacheBehavior = value; }
125 inline StartRunRequest& WithCacheBehavior(CacheBehavior value) { SetCacheBehavior(value); return *this;}
127
129
132 inline const Aws::String& GetRunGroupId() const { return m_runGroupId; }
133 inline bool RunGroupIdHasBeenSet() const { return m_runGroupIdHasBeenSet; }
134 template<typename RunGroupIdT = Aws::String>
135 void SetRunGroupId(RunGroupIdT&& value) { m_runGroupIdHasBeenSet = true; m_runGroupId = std::forward<RunGroupIdT>(value); }
136 template<typename RunGroupIdT = Aws::String>
137 StartRunRequest& WithRunGroupId(RunGroupIdT&& value) { SetRunGroupId(std::forward<RunGroupIdT>(value)); return *this;}
139
141
144 inline int GetPriority() const { return m_priority; }
145 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
146 inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; }
147 inline StartRunRequest& WithPriority(int value) { SetPriority(value); return *this;}
149
151
154 inline Aws::Utils::DocumentView GetParameters() const { return m_parameters; }
155 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
156 template<typename ParametersT = Aws::Utils::Document>
157 void SetParameters(ParametersT&& value) { m_parametersHasBeenSet = true; m_parameters = std::forward<ParametersT>(value); }
158 template<typename ParametersT = Aws::Utils::Document>
159 StartRunRequest& WithParameters(ParametersT&& value) { SetParameters(std::forward<ParametersT>(value)); return *this;}
161
163
168 inline int GetStorageCapacity() const { return m_storageCapacity; }
169 inline bool StorageCapacityHasBeenSet() const { return m_storageCapacityHasBeenSet; }
170 inline void SetStorageCapacity(int value) { m_storageCapacityHasBeenSet = true; m_storageCapacity = value; }
171 inline StartRunRequest& WithStorageCapacity(int value) { SetStorageCapacity(value); return *this;}
173
175
178 inline const Aws::String& GetOutputUri() const { return m_outputUri; }
179 inline bool OutputUriHasBeenSet() const { return m_outputUriHasBeenSet; }
180 template<typename OutputUriT = Aws::String>
181 void SetOutputUri(OutputUriT&& value) { m_outputUriHasBeenSet = true; m_outputUri = std::forward<OutputUriT>(value); }
182 template<typename OutputUriT = Aws::String>
183 StartRunRequest& WithOutputUri(OutputUriT&& value) { SetOutputUri(std::forward<OutputUriT>(value)); return *this;}
185
187
190 inline RunLogLevel GetLogLevel() const { return m_logLevel; }
191 inline bool LogLevelHasBeenSet() const { return m_logLevelHasBeenSet; }
192 inline void SetLogLevel(RunLogLevel value) { m_logLevelHasBeenSet = true; m_logLevel = value; }
193 inline StartRunRequest& WithLogLevel(RunLogLevel value) { SetLogLevel(value); return *this;}
195
197
200 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
201 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
202 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
203 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
204 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
205 StartRunRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
206 template<typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
207 StartRunRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) {
208 m_tagsHasBeenSet = true; m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value)); return *this;
209 }
211
213
217 inline const Aws::String& GetRequestId() const { return m_requestId; }
218 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
219 template<typename RequestIdT = Aws::String>
220 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
221 template<typename RequestIdT = Aws::String>
222 StartRunRequest& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
224
226
240 inline RunRetentionMode GetRetentionMode() const { return m_retentionMode; }
241 inline bool RetentionModeHasBeenSet() const { return m_retentionModeHasBeenSet; }
242 inline void SetRetentionMode(RunRetentionMode value) { m_retentionModeHasBeenSet = true; m_retentionMode = value; }
245
247
256 inline StorageType GetStorageType() const { return m_storageType; }
257 inline bool StorageTypeHasBeenSet() const { return m_storageTypeHasBeenSet; }
258 inline void SetStorageType(StorageType value) { m_storageTypeHasBeenSet = true; m_storageType = value; }
259 inline StartRunRequest& WithStorageType(StorageType value) { SetStorageType(value); return *this;}
261
263
266 inline const Aws::String& GetWorkflowOwnerId() const { return m_workflowOwnerId; }
267 inline bool WorkflowOwnerIdHasBeenSet() const { return m_workflowOwnerIdHasBeenSet; }
268 template<typename WorkflowOwnerIdT = Aws::String>
269 void SetWorkflowOwnerId(WorkflowOwnerIdT&& value) { m_workflowOwnerIdHasBeenSet = true; m_workflowOwnerId = std::forward<WorkflowOwnerIdT>(value); }
270 template<typename WorkflowOwnerIdT = Aws::String>
271 StartRunRequest& WithWorkflowOwnerId(WorkflowOwnerIdT&& value) { SetWorkflowOwnerId(std::forward<WorkflowOwnerIdT>(value)); return *this;}
273
275
278 inline const Aws::String& GetWorkflowVersionName() const { return m_workflowVersionName; }
279 inline bool WorkflowVersionNameHasBeenSet() const { return m_workflowVersionNameHasBeenSet; }
280 template<typename WorkflowVersionNameT = Aws::String>
281 void SetWorkflowVersionName(WorkflowVersionNameT&& value) { m_workflowVersionNameHasBeenSet = true; m_workflowVersionName = std::forward<WorkflowVersionNameT>(value); }
282 template<typename WorkflowVersionNameT = Aws::String>
283 StartRunRequest& WithWorkflowVersionName(WorkflowVersionNameT&& value) { SetWorkflowVersionName(std::forward<WorkflowVersionNameT>(value)); return *this;}
285 private:
286
287 Aws::String m_workflowId;
288 bool m_workflowIdHasBeenSet = false;
289
290 WorkflowType m_workflowType{WorkflowType::NOT_SET};
291 bool m_workflowTypeHasBeenSet = false;
292
293 Aws::String m_runId;
294 bool m_runIdHasBeenSet = false;
295
296 Aws::String m_roleArn;
297 bool m_roleArnHasBeenSet = false;
298
299 Aws::String m_name;
300 bool m_nameHasBeenSet = false;
301
302 Aws::String m_cacheId;
303 bool m_cacheIdHasBeenSet = false;
304
305 CacheBehavior m_cacheBehavior{CacheBehavior::NOT_SET};
306 bool m_cacheBehaviorHasBeenSet = false;
307
308 Aws::String m_runGroupId;
309 bool m_runGroupIdHasBeenSet = false;
310
311 int m_priority{0};
312 bool m_priorityHasBeenSet = false;
313
314 Aws::Utils::Document m_parameters;
315 bool m_parametersHasBeenSet = false;
316
317 int m_storageCapacity{0};
318 bool m_storageCapacityHasBeenSet = false;
319
320 Aws::String m_outputUri;
321 bool m_outputUriHasBeenSet = false;
322
324 bool m_logLevelHasBeenSet = false;
325
327 bool m_tagsHasBeenSet = false;
328
330 bool m_requestIdHasBeenSet = true;
331
333 bool m_retentionModeHasBeenSet = false;
334
335 StorageType m_storageType{StorageType::NOT_SET};
336 bool m_storageTypeHasBeenSet = false;
337
338 Aws::String m_workflowOwnerId;
339 bool m_workflowOwnerIdHasBeenSet = false;
340
341 Aws::String m_workflowVersionName;
342 bool m_workflowVersionNameHasBeenSet = false;
343 };
344
345} // namespace Model
346} // namespace Omics
347} // 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 SetRoleArn(RoleArnT &&value)
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