/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Batch { namespace Model { /** *

An object representing an AWS Batch job definition.

See Also:

* AWS * API Reference

*/ class AWS_BATCH_API JobDefinition { public: JobDefinition(); JobDefinition(Aws::Utils::Json::JsonView jsonValue); JobDefinition& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the job definition.

*/ inline const Aws::String& GetJobDefinitionName() const{ return m_jobDefinitionName; } /** *

The name of the job definition.

*/ inline bool JobDefinitionNameHasBeenSet() const { return m_jobDefinitionNameHasBeenSet; } /** *

The name of the job definition.

*/ inline void SetJobDefinitionName(const Aws::String& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = value; } /** *

The name of the job definition.

*/ inline void SetJobDefinitionName(Aws::String&& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = std::move(value); } /** *

The name of the job definition.

*/ inline void SetJobDefinitionName(const char* value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName.assign(value); } /** *

The name of the job definition.

*/ inline JobDefinition& WithJobDefinitionName(const Aws::String& value) { SetJobDefinitionName(value); return *this;} /** *

The name of the job definition.

*/ inline JobDefinition& WithJobDefinitionName(Aws::String&& value) { SetJobDefinitionName(std::move(value)); return *this;} /** *

The name of the job definition.

*/ inline JobDefinition& WithJobDefinitionName(const char* value) { SetJobDefinitionName(value); return *this;} /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline const Aws::String& GetJobDefinitionArn() const{ return m_jobDefinitionArn; } /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline bool JobDefinitionArnHasBeenSet() const { return m_jobDefinitionArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline void SetJobDefinitionArn(const Aws::String& value) { m_jobDefinitionArnHasBeenSet = true; m_jobDefinitionArn = value; } /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline void SetJobDefinitionArn(Aws::String&& value) { m_jobDefinitionArnHasBeenSet = true; m_jobDefinitionArn = std::move(value); } /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline void SetJobDefinitionArn(const char* value) { m_jobDefinitionArnHasBeenSet = true; m_jobDefinitionArn.assign(value); } /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline JobDefinition& WithJobDefinitionArn(const Aws::String& value) { SetJobDefinitionArn(value); return *this;} /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline JobDefinition& WithJobDefinitionArn(Aws::String&& value) { SetJobDefinitionArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) for the job definition.

*/ inline JobDefinition& WithJobDefinitionArn(const char* value) { SetJobDefinitionArn(value); return *this;} /** *

The revision of the job definition.

*/ inline int GetRevision() const{ return m_revision; } /** *

The revision of the job definition.

*/ inline bool RevisionHasBeenSet() const { return m_revisionHasBeenSet; } /** *

The revision of the job definition.

*/ inline void SetRevision(int value) { m_revisionHasBeenSet = true; m_revision = value; } /** *

The revision of the job definition.

*/ inline JobDefinition& WithRevision(int value) { SetRevision(value); return *this;} /** *

The status of the job definition.

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the job definition.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the job definition.

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the job definition.

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the job definition.

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

The status of the job definition.

*/ inline JobDefinition& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the job definition.

*/ inline JobDefinition& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the job definition.

*/ inline JobDefinition& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

The type of job definition.

*/ inline const Aws::String& GetType() const{ return m_type; } /** *

The type of job definition.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

The type of job definition.

*/ inline void SetType(const Aws::String& value) { m_typeHasBeenSet = true; m_type = value; } /** *

The type of job definition.

*/ inline void SetType(Aws::String&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

The type of job definition.

*/ inline void SetType(const char* value) { m_typeHasBeenSet = true; m_type.assign(value); } /** *

The type of job definition.

*/ inline JobDefinition& WithType(const Aws::String& value) { SetType(value); return *this;} /** *

The type of job definition.

*/ inline JobDefinition& WithType(Aws::String&& value) { SetType(std::move(value)); return *this;} /** *

The type of job definition.

*/ inline JobDefinition& WithType(const char* value) { SetType(value); return *this;} /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline const Aws::Map& GetParameters() const{ return m_parameters; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline void SetParameters(const Aws::Map& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline void SetParameters(Aws::Map&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& WithParameters(const Aws::Map& value) { SetParameters(value); return *this;} /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& WithParameters(Aws::Map&& value) { SetParameters(std::move(value)); return *this;} /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

Default parameters or parameter substitution placeholders that are set in the * job definition. Parameters are specified as a key-value pair mapping. Parameters * in a SubmitJob request override any corresponding parameter * defaults from the job definition. For more information about specifying * parameters, see Job * Definition Parameters in the AWS Batch User Guide.

*/ inline JobDefinition& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline const RetryStrategy& GetRetryStrategy() const{ return m_retryStrategy; } /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline bool RetryStrategyHasBeenSet() const { return m_retryStrategyHasBeenSet; } /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline void SetRetryStrategy(const RetryStrategy& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = value; } /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline void SetRetryStrategy(RetryStrategy&& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = std::move(value); } /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline JobDefinition& WithRetryStrategy(const RetryStrategy& value) { SetRetryStrategy(value); return *this;} /** *

The retry strategy to use for failed jobs that are submitted with this job * definition.

*/ inline JobDefinition& WithRetryStrategy(RetryStrategy&& value) { SetRetryStrategy(std::move(value)); return *this;} /** *

An object with various properties specific to container-based jobs.

*/ inline const ContainerProperties& GetContainerProperties() const{ return m_containerProperties; } /** *

An object with various properties specific to container-based jobs.

*/ inline bool ContainerPropertiesHasBeenSet() const { return m_containerPropertiesHasBeenSet; } /** *

An object with various properties specific to container-based jobs.

*/ inline void SetContainerProperties(const ContainerProperties& value) { m_containerPropertiesHasBeenSet = true; m_containerProperties = value; } /** *

An object with various properties specific to container-based jobs.

*/ inline void SetContainerProperties(ContainerProperties&& value) { m_containerPropertiesHasBeenSet = true; m_containerProperties = std::move(value); } /** *

An object with various properties specific to container-based jobs.

*/ inline JobDefinition& WithContainerProperties(const ContainerProperties& value) { SetContainerProperties(value); return *this;} /** *

An object with various properties specific to container-based jobs.

*/ inline JobDefinition& WithContainerProperties(ContainerProperties&& value) { SetContainerProperties(std::move(value)); return *this;} /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline const JobTimeout& GetTimeout() const{ return m_timeout; } /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; } /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline void SetTimeout(const JobTimeout& value) { m_timeoutHasBeenSet = true; m_timeout = value; } /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline void SetTimeout(JobTimeout&& value) { m_timeoutHasBeenSet = true; m_timeout = std::move(value); } /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline JobDefinition& WithTimeout(const JobTimeout& value) { SetTimeout(value); return *this;} /** *

The timeout configuration for jobs that are submitted with this job * definition. You can specify a timeout duration after which AWS Batch terminates * your jobs if they have not finished.

*/ inline JobDefinition& WithTimeout(JobTimeout&& value) { SetTimeout(std::move(value)); return *this;} /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline const NodeProperties& GetNodeProperties() const{ return m_nodeProperties; } /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline bool NodePropertiesHasBeenSet() const { return m_nodePropertiesHasBeenSet; } /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline void SetNodeProperties(const NodeProperties& value) { m_nodePropertiesHasBeenSet = true; m_nodeProperties = value; } /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline void SetNodeProperties(NodeProperties&& value) { m_nodePropertiesHasBeenSet = true; m_nodeProperties = std::move(value); } /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline JobDefinition& WithNodeProperties(const NodeProperties& value) { SetNodeProperties(value); return *this;} /** *

An object with various properties specific to multi-node parallel jobs.

*/ inline JobDefinition& WithNodeProperties(NodeProperties&& value) { SetNodeProperties(std::move(value)); return *this;} private: Aws::String m_jobDefinitionName; bool m_jobDefinitionNameHasBeenSet; Aws::String m_jobDefinitionArn; bool m_jobDefinitionArnHasBeenSet; int m_revision; bool m_revisionHasBeenSet; Aws::String m_status; bool m_statusHasBeenSet; Aws::String m_type; bool m_typeHasBeenSet; Aws::Map m_parameters; bool m_parametersHasBeenSet; RetryStrategy m_retryStrategy; bool m_retryStrategyHasBeenSet; ContainerProperties m_containerProperties; bool m_containerPropertiesHasBeenSet; JobTimeout m_timeout; bool m_timeoutHasBeenSet; NodeProperties m_nodeProperties; bool m_nodePropertiesHasBeenSet; }; } // namespace Model } // namespace Batch } // namespace Aws