com.amazonaws.services.batch.model.JobDefinition Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An object that represents an Batch job definition.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class JobDefinition implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the job definition.
*
*/
private String jobDefinitionName;
/**
*
* The Amazon Resource Name (ARN) for the job definition.
*
*/
private String jobDefinitionArn;
/**
*
* The revision of the job definition.
*
*/
private Integer revision;
/**
*
* The status of the job definition.
*
*/
private String status;
/**
*
* The type of job definition. It's either container or multinode. If the job is run on
* Fargate resources, then multinode isn't supported. For more information about multi-node parallel
* jobs, see Creating a
* multi-node parallel job definition in the Batch User Guide.
*
*/
private String type;
/**
*
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.
* Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
*
*/
private Integer schedulingPriority;
/**
*
* 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 Batch User Guide.
*
*/
private java.util.Map parameters;
/**
*
* The retry strategy to use for failed jobs that are submitted with this job definition.
*
*/
private RetryStrategy retryStrategy;
/**
*
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the
* job definition, it can't be used in addition to eksProperties, ecsProperties, or
* nodeProperties.
*
*/
private ContainerProperties containerProperties;
/**
*
* The timeout time for jobs that are submitted with this job definition. After the amount of time you specify
* passes, Batch terminates your jobs if they aren't finished.
*
*/
private JobTimeout timeout;
/**
*
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used
* in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
*
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*
*/
private NodeProperties nodeProperties;
/**
*
* The tags that are applied to the job definition.
*
*/
private java.util.Map tags;
/**
*
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
* no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are
* created. For tags with the same name, job tags are given priority over job definitions tags. If the total number
* of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
*
*/
private Boolean propagateTags;
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*/
private java.util.List platformCapabilities;
/**
*
* An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* eksProperties, or nodeProperties.
*
*/
private EcsProperties ecsProperties;
/**
*
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in
* the job definition, it can't be used in addition to containerProperties, ecsProperties,
* or nodeProperties.
*
*/
private EksProperties eksProperties;
/**
*
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
*
*/
private String containerOrchestrationType;
/**
*
* The name of the job definition.
*
*
* @param jobDefinitionName
* The name of the job definition.
*/
public void setJobDefinitionName(String jobDefinitionName) {
this.jobDefinitionName = jobDefinitionName;
}
/**
*
* The name of the job definition.
*
*
* @return The name of the job definition.
*/
public String getJobDefinitionName() {
return this.jobDefinitionName;
}
/**
*
* The name of the job definition.
*
*
* @param jobDefinitionName
* The name of the job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withJobDefinitionName(String jobDefinitionName) {
setJobDefinitionName(jobDefinitionName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the job definition.
*
*
* @param jobDefinitionArn
* The Amazon Resource Name (ARN) for the job definition.
*/
public void setJobDefinitionArn(String jobDefinitionArn) {
this.jobDefinitionArn = jobDefinitionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the job definition.
*
*
* @return The Amazon Resource Name (ARN) for the job definition.
*/
public String getJobDefinitionArn() {
return this.jobDefinitionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the job definition.
*
*
* @param jobDefinitionArn
* The Amazon Resource Name (ARN) for the job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withJobDefinitionArn(String jobDefinitionArn) {
setJobDefinitionArn(jobDefinitionArn);
return this;
}
/**
*
* The revision of the job definition.
*
*
* @param revision
* The revision of the job definition.
*/
public void setRevision(Integer revision) {
this.revision = revision;
}
/**
*
* The revision of the job definition.
*
*
* @return The revision of the job definition.
*/
public Integer getRevision() {
return this.revision;
}
/**
*
* The revision of the job definition.
*
*
* @param revision
* The revision of the job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withRevision(Integer revision) {
setRevision(revision);
return this;
}
/**
*
* The status of the job definition.
*
*
* @param status
* The status of the job definition.
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the job definition.
*
*
* @return The status of the job definition.
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the job definition.
*
*
* @param status
* The status of the job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The type of job definition. It's either container or multinode. If the job is run on
* Fargate resources, then multinode isn't supported. For more information about multi-node parallel
* jobs, see Creating a
* multi-node parallel job definition in the Batch User Guide.
*
*
* @param type
* The type of job definition. It's either container or multinode. If the job is
* run on Fargate resources, then multinode isn't supported. For more information about
* multi-node parallel jobs, see Creating a multi-node
* parallel job definition in the Batch User Guide.
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of job definition. It's either container or multinode. If the job is run on
* Fargate resources, then multinode isn't supported. For more information about multi-node parallel
* jobs, see Creating a
* multi-node parallel job definition in the Batch User Guide.
*
*
* @return The type of job definition. It's either container or multinode. If the job is
* run on Fargate resources, then multinode isn't supported. For more information about
* multi-node parallel jobs, see Creating a multi-node
* parallel job definition in the Batch User Guide.
*/
public String getType() {
return this.type;
}
/**
*
* The type of job definition. It's either container or multinode. If the job is run on
* Fargate resources, then multinode isn't supported. For more information about multi-node parallel
* jobs, see Creating a
* multi-node parallel job definition in the Batch User Guide.
*
*
* @param type
* The type of job definition. It's either container or multinode. If the job is
* run on Fargate resources, then multinode isn't supported. For more information about
* multi-node parallel jobs, see Creating a multi-node
* parallel job definition in the Batch User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withType(String type) {
setType(type);
return this;
}
/**
*
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.
* Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
*
*
* @param schedulingPriority
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share
* policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
*/
public void setSchedulingPriority(Integer schedulingPriority) {
this.schedulingPriority = schedulingPriority;
}
/**
*
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.
* Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
*
*
* @return The scheduling priority of the job definition. This only affects jobs in job queues with a fair share
* policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling
* priority.
*/
public Integer getSchedulingPriority() {
return this.schedulingPriority;
}
/**
*
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.
* Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
*
*
* @param schedulingPriority
* The scheduling priority of the job definition. This only affects jobs in job queues with a fair share
* policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withSchedulingPriority(Integer schedulingPriority) {
setSchedulingPriority(schedulingPriority);
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 Batch User Guide.
*
*
* @return 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 Batch User Guide.
*/
public java.util.Map getParameters() {
return 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 Batch User Guide.
*
*
* @param 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 Batch User Guide.
*/
public void setParameters(java.util.Map parameters) {
this.parameters = 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 Batch User Guide.
*
*
* @param 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 Batch User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withParameters(java.util.Map parameters) {
setParameters(parameters);
return this;
}
/**
* Add a single Parameters entry
*
* @see JobDefinition#withParameters
* @returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition addParametersEntry(String key, String value) {
if (null == this.parameters) {
this.parameters = new java.util.HashMap();
}
if (this.parameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.parameters.put(key, value);
return this;
}
/**
* Removes all the entries added into Parameters.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition clearParametersEntries() {
this.parameters = null;
return this;
}
/**
*
* The retry strategy to use for failed jobs that are submitted with this job definition.
*
*
* @param retryStrategy
* The retry strategy to use for failed jobs that are submitted with this job definition.
*/
public void setRetryStrategy(RetryStrategy retryStrategy) {
this.retryStrategy = retryStrategy;
}
/**
*
* The retry strategy to use for failed jobs that are submitted with this job definition.
*
*
* @return The retry strategy to use for failed jobs that are submitted with this job definition.
*/
public RetryStrategy getRetryStrategy() {
return this.retryStrategy;
}
/**
*
* The retry strategy to use for failed jobs that are submitted with this job definition.
*
*
* @param retryStrategy
* The retry strategy to use for failed jobs that are submitted with this job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withRetryStrategy(RetryStrategy retryStrategy) {
setRetryStrategy(retryStrategy);
return this;
}
/**
*
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the
* job definition, it can't be used in addition to eksProperties, ecsProperties, or
* nodeProperties.
*
*
* @param containerProperties
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used
* in the job definition, it can't be used in addition to eksProperties,
* ecsProperties, or nodeProperties.
*/
public void setContainerProperties(ContainerProperties containerProperties) {
this.containerProperties = containerProperties;
}
/**
*
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the
* job definition, it can't be used in addition to eksProperties, ecsProperties, or
* nodeProperties.
*
*
* @return An object with properties specific to Amazon ECS-based jobs. When containerProperties is
* used in the job definition, it can't be used in addition to eksProperties,
* ecsProperties, or nodeProperties.
*/
public ContainerProperties getContainerProperties() {
return this.containerProperties;
}
/**
*
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the
* job definition, it can't be used in addition to eksProperties, ecsProperties, or
* nodeProperties.
*
*
* @param containerProperties
* An object with properties specific to Amazon ECS-based jobs. When containerProperties is used
* in the job definition, it can't be used in addition to eksProperties,
* ecsProperties, or nodeProperties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withContainerProperties(ContainerProperties containerProperties) {
setContainerProperties(containerProperties);
return this;
}
/**
*
* The timeout time for jobs that are submitted with this job definition. After the amount of time you specify
* passes, Batch terminates your jobs if they aren't finished.
*
*
* @param timeout
* The timeout time for jobs that are submitted with this job definition. After the amount of time you
* specify passes, Batch terminates your jobs if they aren't finished.
*/
public void setTimeout(JobTimeout timeout) {
this.timeout = timeout;
}
/**
*
* The timeout time for jobs that are submitted with this job definition. After the amount of time you specify
* passes, Batch terminates your jobs if they aren't finished.
*
*
* @return The timeout time for jobs that are submitted with this job definition. After the amount of time you
* specify passes, Batch terminates your jobs if they aren't finished.
*/
public JobTimeout getTimeout() {
return this.timeout;
}
/**
*
* The timeout time for jobs that are submitted with this job definition. After the amount of time you specify
* passes, Batch terminates your jobs if they aren't finished.
*
*
* @param timeout
* The timeout time for jobs that are submitted with this job definition. After the amount of time you
* specify passes, Batch terminates your jobs if they aren't finished.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withTimeout(JobTimeout timeout) {
setTimeout(timeout);
return this;
}
/**
*
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used
* in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
*
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*
*
* @param nodeProperties
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties
* is used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*/
public void setNodeProperties(NodeProperties nodeProperties) {
this.nodeProperties = nodeProperties;
}
/**
*
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used
* in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
*
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*
*
* @return An object with properties that are specific to multi-node parallel jobs. When nodeProperties
* is used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*/
public NodeProperties getNodeProperties() {
return this.nodeProperties;
}
/**
*
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used
* in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
*
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
*
*
* @param nodeProperties
* An object with properties that are specific to multi-node parallel jobs. When nodeProperties
* is used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or eksProperties.
*
* If the job runs on Fargate resources, don't specify nodeProperties. Use
* containerProperties instead.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withNodeProperties(NodeProperties nodeProperties) {
setNodeProperties(nodeProperties);
return this;
}
/**
*
* The tags that are applied to the job definition.
*
*
* @return The tags that are applied to the job definition.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The tags that are applied to the job definition.
*
*
* @param tags
* The tags that are applied to the job definition.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The tags that are applied to the job definition.
*
*
* @param tags
* The tags that are applied to the job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see JobDefinition#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
* no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are
* created. For tags with the same name, job tags are given priority over job definitions tags. If the total number
* of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
*
*
* @param propagateTags
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS
* task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when
* the tasks are created. For tags with the same name, job tags are given priority over job definitions tags.
* If the total number of combined tags from the job and job definition is over 50, the job is moved to the
* FAILED state.
*/
public void setPropagateTags(Boolean propagateTags) {
this.propagateTags = propagateTags;
}
/**
*
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
* no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are
* created. For tags with the same name, job tags are given priority over job definitions tags. If the total number
* of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
*
*
* @return Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS
* task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when
* the tasks are created. For tags with the same name, job tags are given priority over job definitions
* tags. If the total number of combined tags from the job and job definition is over 50, the job is moved
* to the FAILED state.
*/
public Boolean getPropagateTags() {
return this.propagateTags;
}
/**
*
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
* no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are
* created. For tags with the same name, job tags are given priority over job definitions tags. If the total number
* of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
*
*
* @param propagateTags
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS
* task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when
* the tasks are created. For tags with the same name, job tags are given priority over job definitions tags.
* If the total number of combined tags from the job and job definition is over 50, the job is moved to the
* FAILED state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withPropagateTags(Boolean propagateTags) {
setPropagateTags(propagateTags);
return this;
}
/**
*
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
* no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are
* created. For tags with the same name, job tags are given priority over job definitions tags. If the total number
* of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
*
*
* @return Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS
* task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when
* the tasks are created. For tags with the same name, job tags are given priority over job definitions
* tags. If the total number of combined tags from the job and job definition is over 50, the job is moved
* to the FAILED state.
*/
public Boolean isPropagateTags() {
return this.propagateTags;
}
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*
* @return The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
* @see PlatformCapability
*/
public java.util.List getPlatformCapabilities() {
return platformCapabilities;
}
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*
* @param platformCapabilities
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
* @see PlatformCapability
*/
public void setPlatformCapabilities(java.util.Collection platformCapabilities) {
if (platformCapabilities == null) {
this.platformCapabilities = null;
return;
}
this.platformCapabilities = new java.util.ArrayList(platformCapabilities);
}
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPlatformCapabilities(java.util.Collection)} or {@link #withPlatformCapabilities(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param platformCapabilities
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlatformCapability
*/
public JobDefinition withPlatformCapabilities(String... platformCapabilities) {
if (this.platformCapabilities == null) {
setPlatformCapabilities(new java.util.ArrayList(platformCapabilities.length));
}
for (String ele : platformCapabilities) {
this.platformCapabilities.add(ele);
}
return this;
}
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*
* @param platformCapabilities
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlatformCapability
*/
public JobDefinition withPlatformCapabilities(java.util.Collection platformCapabilities) {
setPlatformCapabilities(platformCapabilities);
return this;
}
/**
*
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
*
*
* @param platformCapabilities
* The platform capabilities required by the job definition. If no value is specified, it defaults to
* EC2. Jobs run on Fargate resources specify FARGATE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlatformCapability
*/
public JobDefinition withPlatformCapabilities(PlatformCapability... platformCapabilities) {
java.util.ArrayList platformCapabilitiesCopy = new java.util.ArrayList(platformCapabilities.length);
for (PlatformCapability value : platformCapabilities) {
platformCapabilitiesCopy.add(value.toString());
}
if (getPlatformCapabilities() == null) {
setPlatformCapabilities(platformCapabilitiesCopy);
} else {
getPlatformCapabilities().addAll(platformCapabilitiesCopy);
}
return this;
}
/**
*
* An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* eksProperties, or nodeProperties.
*
*
* @param ecsProperties
* An object that contains the properties for the Amazon ECS resources of a job.When
* ecsProperties is used in the job definition, it can't be used in addition to
* containerProperties, eksProperties, or nodeProperties.
*/
public void setEcsProperties(EcsProperties ecsProperties) {
this.ecsProperties = ecsProperties;
}
/**
*
* An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* eksProperties, or nodeProperties.
*
*
* @return An object that contains the properties for the Amazon ECS resources of a job.When
* ecsProperties is used in the job definition, it can't be used in addition to
* containerProperties, eksProperties, or nodeProperties.
*/
public EcsProperties getEcsProperties() {
return this.ecsProperties;
}
/**
*
* An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* eksProperties, or nodeProperties.
*
*
* @param ecsProperties
* An object that contains the properties for the Amazon ECS resources of a job.When
* ecsProperties is used in the job definition, it can't be used in addition to
* containerProperties, eksProperties, or nodeProperties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withEcsProperties(EcsProperties ecsProperties) {
setEcsProperties(ecsProperties);
return this;
}
/**
*
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in
* the job definition, it can't be used in addition to containerProperties, ecsProperties,
* or nodeProperties.
*
*
* @param eksProperties
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or nodeProperties.
*/
public void setEksProperties(EksProperties eksProperties) {
this.eksProperties = eksProperties;
}
/**
*
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in
* the job definition, it can't be used in addition to containerProperties, ecsProperties,
* or nodeProperties.
*
*
* @return An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or nodeProperties.
*/
public EksProperties getEksProperties() {
return this.eksProperties;
}
/**
*
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in
* the job definition, it can't be used in addition to containerProperties, ecsProperties,
* or nodeProperties.
*
*
* @param eksProperties
* An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is
* used in the job definition, it can't be used in addition to containerProperties,
* ecsProperties, or nodeProperties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobDefinition withEksProperties(EksProperties eksProperties) {
setEksProperties(eksProperties);
return this;
}
/**
*
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
*
*
* @param containerOrchestrationType
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
* @see OrchestrationType
*/
public void setContainerOrchestrationType(String containerOrchestrationType) {
this.containerOrchestrationType = containerOrchestrationType;
}
/**
*
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
*
*
* @return The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
* @see OrchestrationType
*/
public String getContainerOrchestrationType() {
return this.containerOrchestrationType;
}
/**
*
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
*
*
* @param containerOrchestrationType
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrchestrationType
*/
public JobDefinition withContainerOrchestrationType(String containerOrchestrationType) {
setContainerOrchestrationType(containerOrchestrationType);
return this;
}
/**
*
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
*
*
* @param containerOrchestrationType
* The orchestration type of the compute environment. The valid values are ECS (default) or
* EKS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrchestrationType
*/
public JobDefinition withContainerOrchestrationType(OrchestrationType containerOrchestrationType) {
this.containerOrchestrationType = containerOrchestrationType.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobDefinitionName() != null)
sb.append("JobDefinitionName: ").append(getJobDefinitionName()).append(",");
if (getJobDefinitionArn() != null)
sb.append("JobDefinitionArn: ").append(getJobDefinitionArn()).append(",");
if (getRevision() != null)
sb.append("Revision: ").append(getRevision()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getSchedulingPriority() != null)
sb.append("SchedulingPriority: ").append(getSchedulingPriority()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getRetryStrategy() != null)
sb.append("RetryStrategy: ").append(getRetryStrategy()).append(",");
if (getContainerProperties() != null)
sb.append("ContainerProperties: ").append(getContainerProperties()).append(",");
if (getTimeout() != null)
sb.append("Timeout: ").append(getTimeout()).append(",");
if (getNodeProperties() != null)
sb.append("NodeProperties: ").append(getNodeProperties()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getPropagateTags() != null)
sb.append("PropagateTags: ").append(getPropagateTags()).append(",");
if (getPlatformCapabilities() != null)
sb.append("PlatformCapabilities: ").append(getPlatformCapabilities()).append(",");
if (getEcsProperties() != null)
sb.append("EcsProperties: ").append(getEcsProperties()).append(",");
if (getEksProperties() != null)
sb.append("EksProperties: ").append(getEksProperties()).append(",");
if (getContainerOrchestrationType() != null)
sb.append("ContainerOrchestrationType: ").append(getContainerOrchestrationType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof JobDefinition == false)
return false;
JobDefinition other = (JobDefinition) obj;
if (other.getJobDefinitionName() == null ^ this.getJobDefinitionName() == null)
return false;
if (other.getJobDefinitionName() != null && other.getJobDefinitionName().equals(this.getJobDefinitionName()) == false)
return false;
if (other.getJobDefinitionArn() == null ^ this.getJobDefinitionArn() == null)
return false;
if (other.getJobDefinitionArn() != null && other.getJobDefinitionArn().equals(this.getJobDefinitionArn()) == false)
return false;
if (other.getRevision() == null ^ this.getRevision() == null)
return false;
if (other.getRevision() != null && other.getRevision().equals(this.getRevision()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getSchedulingPriority() == null ^ this.getSchedulingPriority() == null)
return false;
if (other.getSchedulingPriority() != null && other.getSchedulingPriority().equals(this.getSchedulingPriority()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getRetryStrategy() == null ^ this.getRetryStrategy() == null)
return false;
if (other.getRetryStrategy() != null && other.getRetryStrategy().equals(this.getRetryStrategy()) == false)
return false;
if (other.getContainerProperties() == null ^ this.getContainerProperties() == null)
return false;
if (other.getContainerProperties() != null && other.getContainerProperties().equals(this.getContainerProperties()) == false)
return false;
if (other.getTimeout() == null ^ this.getTimeout() == null)
return false;
if (other.getTimeout() != null && other.getTimeout().equals(this.getTimeout()) == false)
return false;
if (other.getNodeProperties() == null ^ this.getNodeProperties() == null)
return false;
if (other.getNodeProperties() != null && other.getNodeProperties().equals(this.getNodeProperties()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getPropagateTags() == null ^ this.getPropagateTags() == null)
return false;
if (other.getPropagateTags() != null && other.getPropagateTags().equals(this.getPropagateTags()) == false)
return false;
if (other.getPlatformCapabilities() == null ^ this.getPlatformCapabilities() == null)
return false;
if (other.getPlatformCapabilities() != null && other.getPlatformCapabilities().equals(this.getPlatformCapabilities()) == false)
return false;
if (other.getEcsProperties() == null ^ this.getEcsProperties() == null)
return false;
if (other.getEcsProperties() != null && other.getEcsProperties().equals(this.getEcsProperties()) == false)
return false;
if (other.getEksProperties() == null ^ this.getEksProperties() == null)
return false;
if (other.getEksProperties() != null && other.getEksProperties().equals(this.getEksProperties()) == false)
return false;
if (other.getContainerOrchestrationType() == null ^ this.getContainerOrchestrationType() == null)
return false;
if (other.getContainerOrchestrationType() != null && other.getContainerOrchestrationType().equals(this.getContainerOrchestrationType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobDefinitionName() == null) ? 0 : getJobDefinitionName().hashCode());
hashCode = prime * hashCode + ((getJobDefinitionArn() == null) ? 0 : getJobDefinitionArn().hashCode());
hashCode = prime * hashCode + ((getRevision() == null) ? 0 : getRevision().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getSchedulingPriority() == null) ? 0 : getSchedulingPriority().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getRetryStrategy() == null) ? 0 : getRetryStrategy().hashCode());
hashCode = prime * hashCode + ((getContainerProperties() == null) ? 0 : getContainerProperties().hashCode());
hashCode = prime * hashCode + ((getTimeout() == null) ? 0 : getTimeout().hashCode());
hashCode = prime * hashCode + ((getNodeProperties() == null) ? 0 : getNodeProperties().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getPropagateTags() == null) ? 0 : getPropagateTags().hashCode());
hashCode = prime * hashCode + ((getPlatformCapabilities() == null) ? 0 : getPlatformCapabilities().hashCode());
hashCode = prime * hashCode + ((getEcsProperties() == null) ? 0 : getEcsProperties().hashCode());
hashCode = prime * hashCode + ((getEksProperties() == null) ? 0 : getEksProperties().hashCode());
hashCode = prime * hashCode + ((getContainerOrchestrationType() == null) ? 0 : getContainerOrchestrationType().hashCode());
return hashCode;
}
@Override
public JobDefinition clone() {
try {
return (JobDefinition) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.batch.model.transform.JobDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}