AWS SDK for C++  1.8.71
AWS SDK for C++
SubmitJobRequest.h
Go to the documentation of this file.
1 
6 #pragma once
18 #include <utility>
19 
20 namespace Aws
21 {
22 namespace Batch
23 {
24 namespace Model
25 {
26 
30  {
31  public:
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 "SubmitJob"; }
39 
40  Aws::String SerializePayload() const override;
41 
42 
48  inline const Aws::String& GetJobName() const{ return m_jobName; }
49 
55  inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; }
56 
62  inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; }
63 
69  inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); }
70 
76  inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); }
77 
83  inline SubmitJobRequest& WithJobName(const Aws::String& value) { SetJobName(value); return *this;}
84 
90  inline SubmitJobRequest& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;}
91 
97  inline SubmitJobRequest& WithJobName(const char* value) { SetJobName(value); return *this;}
98 
99 
104  inline const Aws::String& GetJobQueue() const{ return m_jobQueue; }
105 
110  inline bool JobQueueHasBeenSet() const { return m_jobQueueHasBeenSet; }
111 
116  inline void SetJobQueue(const Aws::String& value) { m_jobQueueHasBeenSet = true; m_jobQueue = value; }
117 
122  inline void SetJobQueue(Aws::String&& value) { m_jobQueueHasBeenSet = true; m_jobQueue = std::move(value); }
123 
128  inline void SetJobQueue(const char* value) { m_jobQueueHasBeenSet = true; m_jobQueue.assign(value); }
129 
134  inline SubmitJobRequest& WithJobQueue(const Aws::String& value) { SetJobQueue(value); return *this;}
135 
140  inline SubmitJobRequest& WithJobQueue(Aws::String&& value) { SetJobQueue(std::move(value)); return *this;}
141 
146  inline SubmitJobRequest& WithJobQueue(const char* value) { SetJobQueue(value); return *this;}
147 
148 
156  inline const ArrayProperties& GetArrayProperties() const{ return m_arrayProperties; }
157 
165  inline bool ArrayPropertiesHasBeenSet() const { return m_arrayPropertiesHasBeenSet; }
166 
174  inline void SetArrayProperties(const ArrayProperties& value) { m_arrayPropertiesHasBeenSet = true; m_arrayProperties = value; }
175 
183  inline void SetArrayProperties(ArrayProperties&& value) { m_arrayPropertiesHasBeenSet = true; m_arrayProperties = std::move(value); }
184 
192  inline SubmitJobRequest& WithArrayProperties(const ArrayProperties& value) { SetArrayProperties(value); return *this;}
193 
201  inline SubmitJobRequest& WithArrayProperties(ArrayProperties&& value) { SetArrayProperties(std::move(value)); return *this;}
202 
203 
213  inline const Aws::Vector<JobDependency>& GetDependsOn() const{ return m_dependsOn; }
214 
224  inline bool DependsOnHasBeenSet() const { return m_dependsOnHasBeenSet; }
225 
235  inline void SetDependsOn(const Aws::Vector<JobDependency>& value) { m_dependsOnHasBeenSet = true; m_dependsOn = value; }
236 
246  inline void SetDependsOn(Aws::Vector<JobDependency>&& value) { m_dependsOnHasBeenSet = true; m_dependsOn = std::move(value); }
247 
257  inline SubmitJobRequest& WithDependsOn(const Aws::Vector<JobDependency>& value) { SetDependsOn(value); return *this;}
258 
268  inline SubmitJobRequest& WithDependsOn(Aws::Vector<JobDependency>&& value) { SetDependsOn(std::move(value)); return *this;}
269 
279  inline SubmitJobRequest& AddDependsOn(const JobDependency& value) { m_dependsOnHasBeenSet = true; m_dependsOn.push_back(value); return *this; }
280 
290  inline SubmitJobRequest& AddDependsOn(JobDependency&& value) { m_dependsOnHasBeenSet = true; m_dependsOn.push_back(std::move(value)); return *this; }
291 
292 
299  inline const Aws::String& GetJobDefinition() const{ return m_jobDefinition; }
300 
307  inline bool JobDefinitionHasBeenSet() const { return m_jobDefinitionHasBeenSet; }
308 
315  inline void SetJobDefinition(const Aws::String& value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition = value; }
316 
323  inline void SetJobDefinition(Aws::String&& value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition = std::move(value); }
324 
331  inline void SetJobDefinition(const char* value) { m_jobDefinitionHasBeenSet = true; m_jobDefinition.assign(value); }
332 
339  inline SubmitJobRequest& WithJobDefinition(const Aws::String& value) { SetJobDefinition(value); return *this;}
340 
347  inline SubmitJobRequest& WithJobDefinition(Aws::String&& value) { SetJobDefinition(std::move(value)); return *this;}
348 
355  inline SubmitJobRequest& WithJobDefinition(const char* value) { SetJobDefinition(value); return *this;}
356 
357 
364  inline const Aws::Map<Aws::String, Aws::String>& GetParameters() const{ return m_parameters; }
365 
372  inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; }
373 
380  inline void SetParameters(const Aws::Map<Aws::String, Aws::String>& value) { m_parametersHasBeenSet = true; m_parameters = value; }
381 
388  inline void SetParameters(Aws::Map<Aws::String, Aws::String>&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); }
389 
396  inline SubmitJobRequest& WithParameters(const Aws::Map<Aws::String, Aws::String>& value) { SetParameters(value); return *this;}
397 
404  inline SubmitJobRequest& WithParameters(Aws::Map<Aws::String, Aws::String>&& value) { SetParameters(std::move(value)); return *this;}
405 
412  inline SubmitJobRequest& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; }
413 
420  inline SubmitJobRequest& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; }
421 
428  inline SubmitJobRequest& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; }
429 
436  inline SubmitJobRequest& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; }
437 
444  inline SubmitJobRequest& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; }
445 
452  inline SubmitJobRequest& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; }
453 
460  inline SubmitJobRequest& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; }
461 
462 
472  inline const ContainerOverrides& GetContainerOverrides() const{ return m_containerOverrides; }
473 
483  inline bool ContainerOverridesHasBeenSet() const { return m_containerOverridesHasBeenSet; }
484 
494  inline void SetContainerOverrides(const ContainerOverrides& value) { m_containerOverridesHasBeenSet = true; m_containerOverrides = value; }
495 
505  inline void SetContainerOverrides(ContainerOverrides&& value) { m_containerOverridesHasBeenSet = true; m_containerOverrides = std::move(value); }
506 
516  inline SubmitJobRequest& WithContainerOverrides(const ContainerOverrides& value) { SetContainerOverrides(value); return *this;}
517 
527  inline SubmitJobRequest& WithContainerOverrides(ContainerOverrides&& value) { SetContainerOverrides(std::move(value)); return *this;}
528 
529 
534  inline const NodeOverrides& GetNodeOverrides() const{ return m_nodeOverrides; }
535 
540  inline bool NodeOverridesHasBeenSet() const { return m_nodeOverridesHasBeenSet; }
541 
546  inline void SetNodeOverrides(const NodeOverrides& value) { m_nodeOverridesHasBeenSet = true; m_nodeOverrides = value; }
547 
552  inline void SetNodeOverrides(NodeOverrides&& value) { m_nodeOverridesHasBeenSet = true; m_nodeOverrides = std::move(value); }
553 
558  inline SubmitJobRequest& WithNodeOverrides(const NodeOverrides& value) { SetNodeOverrides(value); return *this;}
559 
564  inline SubmitJobRequest& WithNodeOverrides(NodeOverrides&& value) { SetNodeOverrides(std::move(value)); return *this;}
565 
566 
572  inline const RetryStrategy& GetRetryStrategy() const{ return m_retryStrategy; }
573 
579  inline bool RetryStrategyHasBeenSet() const { return m_retryStrategyHasBeenSet; }
580 
586  inline void SetRetryStrategy(const RetryStrategy& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = value; }
587 
593  inline void SetRetryStrategy(RetryStrategy&& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = std::move(value); }
594 
600  inline SubmitJobRequest& WithRetryStrategy(const RetryStrategy& value) { SetRetryStrategy(value); return *this;}
601 
607  inline SubmitJobRequest& WithRetryStrategy(RetryStrategy&& value) { SetRetryStrategy(std::move(value)); return *this;}
608 
609 
621  inline const JobTimeout& GetTimeout() const{ return m_timeout; }
622 
634  inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; }
635 
647  inline void SetTimeout(const JobTimeout& value) { m_timeoutHasBeenSet = true; m_timeout = value; }
648 
660  inline void SetTimeout(JobTimeout&& value) { m_timeoutHasBeenSet = true; m_timeout = std::move(value); }
661 
673  inline SubmitJobRequest& WithTimeout(const JobTimeout& value) { SetTimeout(value); return *this;}
674 
686  inline SubmitJobRequest& WithTimeout(JobTimeout&& value) { SetTimeout(std::move(value)); return *this;}
687 
688 
696  inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
697 
705  inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
706 
714  inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; }
715 
723  inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
724 
732  inline SubmitJobRequest& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
733 
741  inline SubmitJobRequest& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
742 
750  inline SubmitJobRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
751 
759  inline SubmitJobRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
760 
768  inline SubmitJobRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
769 
777  inline SubmitJobRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; }
778 
786  inline SubmitJobRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
787 
795  inline SubmitJobRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
796 
804  inline SubmitJobRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
805 
806  private:
807 
808  Aws::String m_jobName;
809  bool m_jobNameHasBeenSet;
810 
811  Aws::String m_jobQueue;
812  bool m_jobQueueHasBeenSet;
813 
814  ArrayProperties m_arrayProperties;
815  bool m_arrayPropertiesHasBeenSet;
816 
817  Aws::Vector<JobDependency> m_dependsOn;
818  bool m_dependsOnHasBeenSet;
819 
820  Aws::String m_jobDefinition;
821  bool m_jobDefinitionHasBeenSet;
822 
824  bool m_parametersHasBeenSet;
825 
826  ContainerOverrides m_containerOverrides;
827  bool m_containerOverridesHasBeenSet;
828 
829  NodeOverrides m_nodeOverrides;
830  bool m_nodeOverridesHasBeenSet;
831 
832  RetryStrategy m_retryStrategy;
833  bool m_retryStrategyHasBeenSet;
834 
835  JobTimeout m_timeout;
836  bool m_timeoutHasBeenSet;
837 
839  bool m_tagsHasBeenSet;
840  };
841 
842 } // namespace Model
843 } // namespace Batch
844 } // namespace Aws
void SetJobName(const char *value)
const Aws::String & GetJobQueue() const
SubmitJobRequest & AddParameters(const Aws::String &key, Aws::String &&value)
void SetJobQueue(const char *value)
SubmitJobRequest & WithTimeout(const JobTimeout &value)
SubmitJobRequest & AddTags(const Aws::String &key, Aws::String &&value)
const ContainerOverrides & GetContainerOverrides() const
SubmitJobRequest & WithArrayProperties(ArrayProperties &&value)
SubmitJobRequest & WithTimeout(JobTimeout &&value)
SubmitJobRequest & WithNodeOverrides(NodeOverrides &&value)
SubmitJobRequest & AddTags(const char *key, Aws::String &&value)
SubmitJobRequest & AddTags(const Aws::String &key, const Aws::String &value)
SubmitJobRequest & WithParameters(Aws::Map< Aws::String, Aws::String > &&value)
void SetJobDefinition(const Aws::String &value)
SubmitJobRequest & WithJobDefinition(const Aws::String &value)
void SetContainerOverrides(ContainerOverrides &&value)
const Aws::String & GetJobName() const
virtual const char * GetServiceRequestName() const override
void SetParameters(Aws::Map< Aws::String, Aws::String > &&value)
const NodeOverrides & GetNodeOverrides() const
SubmitJobRequest & AddParameters(Aws::String &&key, Aws::String &&value)
const JobTimeout & GetTimeout() const
SubmitJobRequest & WithJobName(const char *value)
void SetJobName(const Aws::String &value)
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
SubmitJobRequest & WithJobQueue(const Aws::String &value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
Definition: AWSMap.h:19
#define AWS_BATCH_API
Definition: Batch_EXPORTS.h:28
void SetJobQueue(const Aws::String &value)
SubmitJobRequest & WithJobName(Aws::String &&value)
const RetryStrategy & GetRetryStrategy() const
SubmitJobRequest & AddParameters(const char *key, const char *value)
SubmitJobRequest & AddTags(Aws::String &&key, const Aws::String &value)
SubmitJobRequest & WithContainerOverrides(ContainerOverrides &&value)
void SetArrayProperties(const ArrayProperties &value)
void SetArrayProperties(ArrayProperties &&value)
SubmitJobRequest & WithRetryStrategy(const RetryStrategy &value)
SubmitJobRequest & WithParameters(const Aws::Map< Aws::String, Aws::String > &value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
SubmitJobRequest & WithDependsOn(const Aws::Vector< JobDependency > &value)
SubmitJobRequest & WithJobDefinition(Aws::String &&value)
void SetJobQueue(Aws::String &&value)
SubmitJobRequest & WithDependsOn(Aws::Vector< JobDependency > &&value)
void SetTimeout(const JobTimeout &value)
void SetJobDefinition(const char *value)
SubmitJobRequest & AddParameters(Aws::String &&key, const Aws::String &value)
SubmitJobRequest & WithJobDefinition(const char *value)
const Aws::Vector< JobDependency > & GetDependsOn() const
SubmitJobRequest & AddTags(Aws::String &&key, const char *value)
SubmitJobRequest & WithJobQueue(const char *value)
SubmitJobRequest & WithRetryStrategy(RetryStrategy &&value)
void SetJobName(Aws::String &&value)
void SetParameters(const Aws::Map< Aws::String, Aws::String > &value)
const Aws::String & GetJobDefinition() const
void SetTags(Aws::Map< Aws::String, Aws::String > &&value)
void SetRetryStrategy(RetryStrategy &&value)
SubmitJobRequest & AddTags(Aws::String &&key, Aws::String &&value)
SubmitJobRequest & AddParameters(const char *key, Aws::String &&value)
SubmitJobRequest & WithNodeOverrides(const NodeOverrides &value)
SubmitJobRequest & WithArrayProperties(const ArrayProperties &value)
SubmitJobRequest & WithTags(const Aws::Map< Aws::String, Aws::String > &value)
SubmitJobRequest & AddTags(const char *key, const char *value)
SubmitJobRequest & WithJobQueue(Aws::String &&value)
void SetTags(const Aws::Map< Aws::String, Aws::String > &value)
void SetJobDefinition(Aws::String &&value)
SubmitJobRequest & WithContainerOverrides(const ContainerOverrides &value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
void SetNodeOverrides(NodeOverrides &&value)
SubmitJobRequest & AddParameters(Aws::String &&key, const char *value)
void SetRetryStrategy(const RetryStrategy &value)
void SetDependsOn(Aws::Vector< JobDependency > &&value)
void SetDependsOn(const Aws::Vector< JobDependency > &value)
SubmitJobRequest & WithJobName(const Aws::String &value)
void SetContainerOverrides(const ContainerOverrides &value)
const ArrayProperties & GetArrayProperties() const
const Aws::Map< Aws::String, Aws::String > & GetParameters() const
SubmitJobRequest & AddDependsOn(const JobDependency &value)
SubmitJobRequest & WithTags(Aws::Map< Aws::String, Aws::String > &&value)
void SetNodeOverrides(const NodeOverrides &value)
SubmitJobRequest & AddParameters(const Aws::String &key, const Aws::String &value)
SubmitJobRequest & AddDependsOn(JobDependency &&value)
void SetTimeout(JobTimeout &&value)