AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
SubmitJobRequest.h
1
6#pragma once
7#include <aws/batch/Batch_EXPORTS.h>
8#include <aws/batch/BatchRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/batch/model/ArrayProperties.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/core/utils/memory/stl/AWSMap.h>
13#include <aws/batch/model/ContainerOverrides.h>
14#include <aws/batch/model/NodeOverrides.h>
15#include <aws/batch/model/RetryStrategy.h>
16#include <aws/batch/model/JobTimeout.h>
17#include <aws/batch/model/EksPropertiesOverride.h>
18#include <aws/batch/model/EcsPropertiesOverride.h>
19#include <aws/batch/model/JobDependency.h>
20#include <utility>
21
22namespace Aws
23{
24namespace Batch
25{
26namespace Model
27{
28
36 {
37 public:
38 AWS_BATCH_API SubmitJobRequest();
39
40 // Service request name is the Operation name which will send this request out,
41 // each operation should has unique request name, so that we can get operation's name from this request.
42 // Note: this is not true for response, multiple operations may have the same response name,
43 // so we can not get operation's name from response.
44 inline virtual const char* GetServiceRequestName() const override { return "SubmitJob"; }
45
46 AWS_BATCH_API Aws::String SerializePayload() const override;
47
48
50
55 inline const Aws::String& GetJobName() const{ return m_jobName; }
56 inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; }
57 inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; }
58 inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); }
59 inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); }
60 inline SubmitJobRequest& WithJobName(const Aws::String& value) { SetJobName(value); return *this;}
61 inline SubmitJobRequest& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;}
62 inline SubmitJobRequest& WithJobName(const char* value) { SetJobName(value); return *this;}
64
66
70 inline const Aws::String& GetJobQueue() const{ return m_jobQueue; }
71 inline bool JobQueueHasBeenSet() const { return m_jobQueueHasBeenSet; }
72 inline void SetJobQueue(const Aws::String& value) { m_jobQueueHasBeenSet = true; m_jobQueue = value; }
73 inline void SetJobQueue(Aws::String&& value) { m_jobQueueHasBeenSet = true; m_jobQueue = std::move(value); }
74 inline void SetJobQueue(const char* value) { m_jobQueueHasBeenSet = true; m_jobQueue.assign(value); }
75 inline SubmitJobRequest& WithJobQueue(const Aws::String& value) { SetJobQueue(value); return *this;}
76 inline SubmitJobRequest& WithJobQueue(Aws::String&& value) { SetJobQueue(std::move(value)); return *this;}
77 inline SubmitJobRequest& WithJobQueue(const char* value) { SetJobQueue(value); return *this;}
79
81
87 inline const Aws::String& GetShareIdentifier() const{ return m_shareIdentifier; }
88 inline bool ShareIdentifierHasBeenSet() const { return m_shareIdentifierHasBeenSet; }
89 inline void SetShareIdentifier(const Aws::String& value) { m_shareIdentifierHasBeenSet = true; m_shareIdentifier = value; }
90 inline void SetShareIdentifier(Aws::String&& value) { m_shareIdentifierHasBeenSet = true; m_shareIdentifier = std::move(value); }
91 inline void SetShareIdentifier(const char* value) { m_shareIdentifierHasBeenSet = true; m_shareIdentifier.assign(value); }
92 inline SubmitJobRequest& WithShareIdentifier(const Aws::String& value) { SetShareIdentifier(value); return *this;}
93 inline SubmitJobRequest& WithShareIdentifier(Aws::String&& value) { SetShareIdentifier(std::move(value)); return *this;}
94 inline SubmitJobRequest& WithShareIdentifier(const char* value) { SetShareIdentifier(value); return *this;}
96
98
106 inline int GetSchedulingPriorityOverride() const{ return m_schedulingPriorityOverride; }
107 inline bool SchedulingPriorityOverrideHasBeenSet() const { return m_schedulingPriorityOverrideHasBeenSet; }
108 inline void SetSchedulingPriorityOverride(int value) { m_schedulingPriorityOverrideHasBeenSet = true; m_schedulingPriorityOverride = value; }
111
113
120 inline const ArrayProperties& GetArrayProperties() const{ return m_arrayProperties; }
121 inline bool ArrayPropertiesHasBeenSet() const { return m_arrayPropertiesHasBeenSet; }
122 inline void SetArrayProperties(const ArrayProperties& value) { m_arrayPropertiesHasBeenSet = true; m_arrayProperties = value; }
123 inline void SetArrayProperties(ArrayProperties&& value) { m_arrayPropertiesHasBeenSet = true; m_arrayProperties = std::move(value); }
124 inline SubmitJobRequest& WithArrayProperties(const ArrayProperties& value) { SetArrayProperties(value); return *this;}
125 inline SubmitJobRequest& WithArrayProperties(ArrayProperties&& value) { SetArrayProperties(std::move(value)); return *this;}
127
129
138 inline const Aws::Vector<JobDependency>& GetDependsOn() const{ return m_dependsOn; }
139 inline bool DependsOnHasBeenSet() const { return m_dependsOnHasBeenSet; }
140 inline void SetDependsOn(const Aws::Vector<JobDependency>& value) { m_dependsOnHasBeenSet = true; m_dependsOn = value; }
141 inline void SetDependsOn(Aws::Vector<JobDependency>&& value) { m_dependsOnHasBeenSet = true; m_dependsOn = std::move(value); }
142 inline SubmitJobRequest& WithDependsOn(const Aws::Vector<JobDependency>& value) { SetDependsOn(value); return *this;}
143 inline SubmitJobRequest& WithDependsOn(Aws::Vector<JobDependency>&& value) { SetDependsOn(std::move(value)); return *this;}
144 inline SubmitJobRequest& AddDependsOn(const JobDependency& value) { m_dependsOnHasBeenSet = true; m_dependsOn.push_back(value); return *this; }
145 inline SubmitJobRequest& AddDependsOn(JobDependency&& value) { m_dependsOnHasBeenSet = true; m_dependsOn.push_back(std::move(value)); return *this; }
147
149
159 inline const Aws::String& GetJobDefinition() const{ return m_jobDefinition; }
160 inline bool JobDefinitionHasBeenSet() const { return m_jobDefinitionHasBeenSet; }
161 inline void SetJobDefinition(const Aws::String& value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition = value; }
162 inline void SetJobDefinition(Aws::String&& value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition = std::move(value); }
163 inline void SetJobDefinition(const char* value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition.assign(value); }
164 inline SubmitJobRequest& WithJobDefinition(const Aws::String& value) { SetJobDefinition(value); return *this;}
165 inline SubmitJobRequest& WithJobDefinition(Aws::String&& value) { SetJobDefinition(std::move(value)); return *this;}
166 inline SubmitJobRequest& WithJobDefinition(const char* value) { SetJobDefinition(value); return *this;}
168
170
176 inline const Aws::Map<Aws::String, Aws::String>& GetParameters() const{ return m_parameters; }
177 inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
178 inline void SetParameters(const Aws::Map<Aws::String, Aws::String>& value) { m_parametersHasBeenSet = true; m_parameters = value; }
179 inline void SetParameters(Aws::Map<Aws::String, Aws::String>&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); }
181 inline SubmitJobRequest& WithParameters(Aws::Map<Aws::String, Aws::String>&& value) { SetParameters(std::move(value)); return *this;}
182 inline SubmitJobRequest& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; }
183 inline SubmitJobRequest& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; }
184 inline SubmitJobRequest& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; }
185 inline SubmitJobRequest& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; }
186 inline SubmitJobRequest& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; }
187 inline SubmitJobRequest& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; }
188 inline SubmitJobRequest& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; }
190
192
201 inline const ContainerOverrides& GetContainerOverrides() const{ return m_containerOverrides; }
202 inline bool ContainerOverridesHasBeenSet() const { return m_containerOverridesHasBeenSet; }
203 inline void SetContainerOverrides(const ContainerOverrides& value) { m_containerOverridesHasBeenSet = true; m_containerOverrides = value; }
204 inline void SetContainerOverrides(ContainerOverrides&& value) { m_containerOverridesHasBeenSet = true; m_containerOverrides = std::move(value); }
206 inline SubmitJobRequest& WithContainerOverrides(ContainerOverrides&& value) { SetContainerOverrides(std::move(value)); return *this;}
208
210
216 inline const NodeOverrides& GetNodeOverrides() const{ return m_nodeOverrides; }
217 inline bool NodeOverridesHasBeenSet() const { return m_nodeOverridesHasBeenSet; }
218 inline void SetNodeOverrides(const NodeOverrides& value) { m_nodeOverridesHasBeenSet = true; m_nodeOverrides = value; }
219 inline void SetNodeOverrides(NodeOverrides&& value) { m_nodeOverridesHasBeenSet = true; m_nodeOverrides = std::move(value); }
220 inline SubmitJobRequest& WithNodeOverrides(const NodeOverrides& value) { SetNodeOverrides(value); return *this;}
221 inline SubmitJobRequest& WithNodeOverrides(NodeOverrides&& value) { SetNodeOverrides(std::move(value)); return *this;}
223
225
230 inline const RetryStrategy& GetRetryStrategy() const{ return m_retryStrategy; }
231 inline bool RetryStrategyHasBeenSet() const { return m_retryStrategyHasBeenSet; }
232 inline void SetRetryStrategy(const RetryStrategy& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = value; }
233 inline void SetRetryStrategy(RetryStrategy&& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = std::move(value); }
234 inline SubmitJobRequest& WithRetryStrategy(const RetryStrategy& value) { SetRetryStrategy(value); return *this;}
235 inline SubmitJobRequest& WithRetryStrategy(RetryStrategy&& value) { SetRetryStrategy(std::move(value)); return *this;}
237
239
248 inline bool GetPropagateTags() const{ return m_propagateTags; }
249 inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; }
250 inline void SetPropagateTags(bool value) { m_propagateTagsHasBeenSet = true; m_propagateTags = value; }
251 inline SubmitJobRequest& WithPropagateTags(bool value) { SetPropagateTags(value); return *this;}
253
255
266 inline const JobTimeout& GetTimeout() const{ return m_timeout; }
267 inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; }
268 inline void SetTimeout(const JobTimeout& value) { m_timeoutHasBeenSet = true; m_timeout = value; }
269 inline void SetTimeout(JobTimeout&& value) { m_timeoutHasBeenSet = true; m_timeout = std::move(value); }
270 inline SubmitJobRequest& WithTimeout(const JobTimeout& value) { SetTimeout(value); return *this;}
271 inline SubmitJobRequest& WithTimeout(JobTimeout&& value) { SetTimeout(std::move(value)); return *this;}
273
275
283 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
284 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
285 inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; }
286 inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
287 inline SubmitJobRequest& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
288 inline SubmitJobRequest& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
289 inline SubmitJobRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
290 inline SubmitJobRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
291 inline SubmitJobRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
292 inline SubmitJobRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; }
293 inline SubmitJobRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
294 inline SubmitJobRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
295 inline SubmitJobRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
297
299
303 inline const EksPropertiesOverride& GetEksPropertiesOverride() const{ return m_eksPropertiesOverride; }
304 inline bool EksPropertiesOverrideHasBeenSet() const { return m_eksPropertiesOverrideHasBeenSet; }
305 inline void SetEksPropertiesOverride(const EksPropertiesOverride& value) { m_eksPropertiesOverrideHasBeenSet = true; m_eksPropertiesOverride = value; }
306 inline void SetEksPropertiesOverride(EksPropertiesOverride&& value) { m_eksPropertiesOverrideHasBeenSet = true; m_eksPropertiesOverride = std::move(value); }
310
312
316 inline const EcsPropertiesOverride& GetEcsPropertiesOverride() const{ return m_ecsPropertiesOverride; }
317 inline bool EcsPropertiesOverrideHasBeenSet() const { return m_ecsPropertiesOverrideHasBeenSet; }
318 inline void SetEcsPropertiesOverride(const EcsPropertiesOverride& value) { m_ecsPropertiesOverrideHasBeenSet = true; m_ecsPropertiesOverride = value; }
319 inline void SetEcsPropertiesOverride(EcsPropertiesOverride&& value) { m_ecsPropertiesOverrideHasBeenSet = true; m_ecsPropertiesOverride = std::move(value); }
323 private:
324
325 Aws::String m_jobName;
326 bool m_jobNameHasBeenSet = false;
327
328 Aws::String m_jobQueue;
329 bool m_jobQueueHasBeenSet = false;
330
331 Aws::String m_shareIdentifier;
332 bool m_shareIdentifierHasBeenSet = false;
333
334 int m_schedulingPriorityOverride;
335 bool m_schedulingPriorityOverrideHasBeenSet = false;
336
337 ArrayProperties m_arrayProperties;
338 bool m_arrayPropertiesHasBeenSet = false;
339
340 Aws::Vector<JobDependency> m_dependsOn;
341 bool m_dependsOnHasBeenSet = false;
342
343 Aws::String m_jobDefinition;
344 bool m_jobDefinitionHasBeenSet = false;
345
347 bool m_parametersHasBeenSet = false;
348
349 ContainerOverrides m_containerOverrides;
350 bool m_containerOverridesHasBeenSet = false;
351
352 NodeOverrides m_nodeOverrides;
353 bool m_nodeOverridesHasBeenSet = false;
354
355 RetryStrategy m_retryStrategy;
356 bool m_retryStrategyHasBeenSet = false;
357
358 bool m_propagateTags;
359 bool m_propagateTagsHasBeenSet = false;
360
361 JobTimeout m_timeout;
362 bool m_timeoutHasBeenSet = false;
363
365 bool m_tagsHasBeenSet = false;
366
367 EksPropertiesOverride m_eksPropertiesOverride;
368 bool m_eksPropertiesOverrideHasBeenSet = false;
369
370 EcsPropertiesOverride m_ecsPropertiesOverride;
371 bool m_ecsPropertiesOverrideHasBeenSet = false;
372 };
373
374} // namespace Model
375} // namespace Batch
376} // namespace Aws
const NodeOverrides & GetNodeOverrides() const
SubmitJobRequest & WithEcsPropertiesOverride(const EcsPropertiesOverride &value)
SubmitJobRequest & WithEksPropertiesOverride(const EksPropertiesOverride &value)
SubmitJobRequest & WithShareIdentifier(const char *value)
void SetJobQueue(const char *value)
void SetTags(Aws::Map< Aws::String, Aws::String > &&value)
SubmitJobRequest & WithNodeOverrides(const NodeOverrides &value)
SubmitJobRequest & WithJobName(Aws::String &&value)
const Aws::String & GetJobDefinition() const
void SetContainerOverrides(ContainerOverrides &&value)
void SetJobName(const Aws::String &value)
void SetTimeout(JobTimeout &&value)
SubmitJobRequest & AddDependsOn(const JobDependency &value)
SubmitJobRequest & WithShareIdentifier(Aws::String &&value)
SubmitJobRequest & AddParameters(const char *key, const char *value)
void SetContainerOverrides(const ContainerOverrides &value)
void SetRetryStrategy(RetryStrategy &&value)
const Aws::String & GetJobName() const
void SetJobQueue(Aws::String &&value)
void SetEksPropertiesOverride(EksPropertiesOverride &&value)
SubmitJobRequest & AddParameters(const char *key, Aws::String &&value)
SubmitJobRequest & AddTags(const Aws::String &key, Aws::String &&value)
SubmitJobRequest & WithEksPropertiesOverride(EksPropertiesOverride &&value)
SubmitJobRequest & AddTags(Aws::String &&key, const Aws::String &value)
void SetArrayProperties(const ArrayProperties &value)
void SetJobDefinition(const Aws::String &value)
const Aws::String & GetJobQueue() const
SubmitJobRequest & AddParameters(Aws::String &&key, const char *value)
SubmitJobRequest & WithJobQueue(const Aws::String &value)
void SetNodeOverrides(NodeOverrides &&value)
SubmitJobRequest & WithTimeout(JobTimeout &&value)
void SetParameters(Aws::Map< Aws::String, Aws::String > &&value)
SubmitJobRequest & WithParameters(const Aws::Map< Aws::String, Aws::String > &value)
void SetRetryStrategy(const RetryStrategy &value)
const Aws::String & GetShareIdentifier() const
virtual const char * GetServiceRequestName() const override
SubmitJobRequest & WithSchedulingPriorityOverride(int value)
void SetTags(const Aws::Map< Aws::String, Aws::String > &value)
SubmitJobRequest & AddParameters(const Aws::String &key, Aws::String &&value)
SubmitJobRequest & WithTags(Aws::Map< Aws::String, Aws::String > &&value)
SubmitJobRequest & WithParameters(Aws::Map< Aws::String, Aws::String > &&value)
SubmitJobRequest & WithTimeout(const JobTimeout &value)
SubmitJobRequest & WithRetryStrategy(const RetryStrategy &value)
SubmitJobRequest & AddParameters(Aws::String &&key, Aws::String &&value)
void SetEcsPropertiesOverride(EcsPropertiesOverride &&value)
SubmitJobRequest & AddParameters(Aws::String &&key, const Aws::String &value)
void SetShareIdentifier(Aws::String &&value)
SubmitJobRequest & WithJobName(const Aws::String &value)
SubmitJobRequest & WithShareIdentifier(const Aws::String &value)
void SetArrayProperties(ArrayProperties &&value)
const EcsPropertiesOverride & GetEcsPropertiesOverride() const
SubmitJobRequest & WithJobName(const char *value)
void SetParameters(const Aws::Map< Aws::String, Aws::String > &value)
SubmitJobRequest & WithDependsOn(const Aws::Vector< JobDependency > &value)
void SetDependsOn(Aws::Vector< JobDependency > &&value)
SubmitJobRequest & AddTags(Aws::String &&key, const char *value)
SubmitJobRequest & WithEcsPropertiesOverride(EcsPropertiesOverride &&value)
void SetJobName(Aws::String &&value)
SubmitJobRequest & WithPropagateTags(bool value)
void SetShareIdentifier(const Aws::String &value)
SubmitJobRequest & WithContainerOverrides(ContainerOverrides &&value)
const RetryStrategy & GetRetryStrategy() const
void SetNodeOverrides(const NodeOverrides &value)
AWS_BATCH_API Aws::String SerializePayload() const override
SubmitJobRequest & AddDependsOn(JobDependency &&value)
SubmitJobRequest & AddTags(const Aws::String &key, const Aws::String &value)
SubmitJobRequest & WithArrayProperties(const ArrayProperties &value)
SubmitJobRequest & WithNodeOverrides(NodeOverrides &&value)
void SetDependsOn(const Aws::Vector< JobDependency > &value)
void SetEcsPropertiesOverride(const EcsPropertiesOverride &value)
const JobTimeout & GetTimeout() const
const Aws::Map< Aws::String, Aws::String > & GetParameters() const
SubmitJobRequest & WithTags(const Aws::Map< Aws::String, Aws::String > &value)
SubmitJobRequest & WithArrayProperties(ArrayProperties &&value)
SubmitJobRequest & WithContainerOverrides(const ContainerOverrides &value)
SubmitJobRequest & WithDependsOn(Aws::Vector< JobDependency > &&value)
SubmitJobRequest & AddTags(Aws::String &&key, Aws::String &&value)
SubmitJobRequest & WithJobQueue(Aws::String &&value)
const EksPropertiesOverride & GetEksPropertiesOverride() const
void SetShareIdentifier(const char *value)
SubmitJobRequest & WithRetryStrategy(RetryStrategy &&value)
void SetJobQueue(const Aws::String &value)
const Aws::Vector< JobDependency > & GetDependsOn() const
void SetJobDefinition(Aws::String &&value)
SubmitJobRequest & WithJobDefinition(const Aws::String &value)
const ArrayProperties & GetArrayProperties() const
void SetJobDefinition(const char *value)
SubmitJobRequest & WithJobDefinition(Aws::String &&value)
void SetTimeout(const JobTimeout &value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
SubmitJobRequest & WithJobQueue(const char *value)
SubmitJobRequest & AddTags(const char *key, Aws::String &&value)
SubmitJobRequest & WithJobDefinition(const char *value)
SubmitJobRequest & AddTags(const char *key, const char *value)
const ContainerOverrides & GetContainerOverrides() const
void SetEksPropertiesOverride(const EksPropertiesOverride &value)
SubmitJobRequest & AddParameters(const Aws::String &key, const Aws::String &value)
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