@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class JobDetail extends Object implements Serializable, Cloneable, StructuredPojo
An object that represents an Batch job.
Constructor and Description |
---|
JobDetail() |
Modifier and Type | Method and Description |
---|---|
JobDetail |
addParametersEntry(String key,
String value)
Add a single Parameters entry
|
JobDetail |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
JobDetail |
clearParametersEntries()
Removes all the entries added into Parameters.
|
JobDetail |
clearTagsEntries()
Removes all the entries added into Tags.
|
JobDetail |
clone() |
boolean |
equals(Object obj) |
ArrayPropertiesDetail |
getArrayProperties()
The array properties of the job, if it's an array job.
|
List<AttemptDetail> |
getAttempts()
A list of job attempts that are associated with this job.
|
ContainerDetail |
getContainer()
An object that represents the details for the container that's associated with the job.
|
Long |
getCreatedAt()
The Unix timestamp (in milliseconds) for when the job was created.
|
List<JobDependency> |
getDependsOn()
A list of job IDs that this job depends on.
|
EcsPropertiesDetail |
getEcsProperties()
An object with properties that are specific to Amazon ECS-based jobs.
|
List<EksAttemptDetail> |
getEksAttempts()
A list of job attempts that are associated with this job.
|
EksPropertiesDetail |
getEksProperties()
An object with various properties that are specific to Amazon EKS based jobs.
|
Boolean |
getIsCancelled()
Indicates whether the job is canceled.
|
Boolean |
getIsTerminated()
Indicates whether the job is terminated.
|
String |
getJobArn()
The Amazon Resource Name (ARN) of the job.
|
String |
getJobDefinition()
The Amazon Resource Name (ARN) of the job definition that this job uses.
|
String |
getJobId()
The job ID.
|
String |
getJobName()
The job name.
|
String |
getJobQueue()
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
|
NodeDetails |
getNodeDetails()
An object that represents the details of a node that's associated with a multi-node parallel job.
|
NodeProperties |
getNodeProperties()
An object that represents the node properties of a multi-node parallel job.
|
Map<String,String> |
getParameters()
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any
corresponding parameter defaults from the job definition.
|
List<String> |
getPlatformCapabilities()
The platform capabilities required by the job definition.
|
Boolean |
getPropagateTags()
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
RetryStrategy |
getRetryStrategy()
The retry strategy to use for this job if an attempt fails.
|
Integer |
getSchedulingPriority()
The scheduling policy of the job definition.
|
String |
getShareIdentifier()
The share identifier for the job.
|
Long |
getStartedAt()
The Unix timestamp (in milliseconds) for when the job was started.
|
String |
getStatus()
The current status for the job.
|
String |
getStatusReason()
A short, human-readable string to provide more details for the current status of the job.
|
Long |
getStoppedAt()
The Unix timestamp (in milliseconds) for when the job was stopped.
|
Map<String,String> |
getTags()
The tags that are applied to the job.
|
JobTimeout |
getTimeout()
The timeout configuration for the job.
|
int |
hashCode() |
Boolean |
isCancelled()
Indicates whether the job is canceled.
|
Boolean |
isPropagateTags()
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
Boolean |
isTerminated()
Indicates whether the job is terminated.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
|
void |
setAttempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
|
void |
setContainer(ContainerDetail container)
An object that represents the details for the container that's associated with the job.
|
void |
setCreatedAt(Long createdAt)
The Unix timestamp (in milliseconds) for when the job was created.
|
void |
setDependsOn(Collection<JobDependency> dependsOn)
A list of job IDs that this job depends on.
|
void |
setEcsProperties(EcsPropertiesDetail ecsProperties)
An object with properties that are specific to Amazon ECS-based jobs.
|
void |
setEksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
|
void |
setEksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
void |
setIsCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
|
void |
setIsTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
|
void |
setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
|
void |
setJobDefinition(String jobDefinition)
The Amazon Resource Name (ARN) of the job definition that this job uses.
|
void |
setJobId(String jobId)
The job ID.
|
void |
setJobName(String jobName)
The job name.
|
void |
setJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
|
void |
setNodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
|
void |
setNodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
|
void |
setParameters(Map<String,String> parameters)
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any
corresponding parameter defaults from the job definition.
|
void |
setPlatformCapabilities(Collection<String> platformCapabilities)
The platform capabilities required by the job definition.
|
void |
setPropagateTags(Boolean propagateTags)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
void |
setRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
|
void |
setSchedulingPriority(Integer schedulingPriority)
The scheduling policy of the job definition.
|
void |
setShareIdentifier(String shareIdentifier)
The share identifier for the job.
|
void |
setStartedAt(Long startedAt)
The Unix timestamp (in milliseconds) for when the job was started.
|
void |
setStatus(JobStatus status)
The current status for the job.
|
void |
setStatus(String status)
The current status for the job.
|
void |
setStatusReason(String statusReason)
A short, human-readable string to provide more details for the current status of the job.
|
void |
setStoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped.
|
void |
setTags(Map<String,String> tags)
The tags that are applied to the job.
|
void |
setTimeout(JobTimeout timeout)
The timeout configuration for the job.
|
String |
toString()
Returns a string representation of this object.
|
JobDetail |
withArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
|
JobDetail |
withAttempts(AttemptDetail... attempts)
A list of job attempts that are associated with this job.
|
JobDetail |
withAttempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
|
JobDetail |
withContainer(ContainerDetail container)
An object that represents the details for the container that's associated with the job.
|
JobDetail |
withCreatedAt(Long createdAt)
The Unix timestamp (in milliseconds) for when the job was created.
|
JobDetail |
withDependsOn(Collection<JobDependency> dependsOn)
A list of job IDs that this job depends on.
|
JobDetail |
withDependsOn(JobDependency... dependsOn)
A list of job IDs that this job depends on.
|
JobDetail |
withEcsProperties(EcsPropertiesDetail ecsProperties)
An object with properties that are specific to Amazon ECS-based jobs.
|
JobDetail |
withEksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
|
JobDetail |
withEksAttempts(EksAttemptDetail... eksAttempts)
A list of job attempts that are associated with this job.
|
JobDetail |
withEksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
JobDetail |
withIsCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
|
JobDetail |
withIsTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
|
JobDetail |
withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
|
JobDetail |
withJobDefinition(String jobDefinition)
The Amazon Resource Name (ARN) of the job definition that this job uses.
|
JobDetail |
withJobId(String jobId)
The job ID.
|
JobDetail |
withJobName(String jobName)
The job name.
|
JobDetail |
withJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
|
JobDetail |
withNodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
|
JobDetail |
withNodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
|
JobDetail |
withParameters(Map<String,String> parameters)
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any
corresponding parameter defaults from the job definition.
|
JobDetail |
withPlatformCapabilities(Collection<String> platformCapabilities)
The platform capabilities required by the job definition.
|
JobDetail |
withPlatformCapabilities(PlatformCapability... platformCapabilities)
The platform capabilities required by the job definition.
|
JobDetail |
withPlatformCapabilities(String... platformCapabilities)
The platform capabilities required by the job definition.
|
JobDetail |
withPropagateTags(Boolean propagateTags)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
JobDetail |
withRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
|
JobDetail |
withSchedulingPriority(Integer schedulingPriority)
The scheduling policy of the job definition.
|
JobDetail |
withShareIdentifier(String shareIdentifier)
The share identifier for the job.
|
JobDetail |
withStartedAt(Long startedAt)
The Unix timestamp (in milliseconds) for when the job was started.
|
JobDetail |
withStatus(JobStatus status)
The current status for the job.
|
JobDetail |
withStatus(String status)
The current status for the job.
|
JobDetail |
withStatusReason(String statusReason)
A short, human-readable string to provide more details for the current status of the job.
|
JobDetail |
withStoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped.
|
JobDetail |
withTags(Map<String,String> tags)
The tags that are applied to the job.
|
JobDetail |
withTimeout(JobTimeout timeout)
The timeout configuration for the job.
|
public void setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn
- The Amazon Resource Name (ARN) of the job.public String getJobArn()
The Amazon Resource Name (ARN) of the job.
public JobDetail withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn
- The Amazon Resource Name (ARN) of the job.public void setJobName(String jobName)
The job name.
jobName
- The job name.public String getJobName()
The job name.
public JobDetail withJobName(String jobName)
The job name.
jobName
- The job name.public void setJobId(String jobId)
The job ID.
jobId
- The job ID.public String getJobId()
The job ID.
public JobDetail withJobId(String jobId)
The job ID.
jobId
- The job ID.public void setJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
jobQueue
- The Amazon Resource Name (ARN) of the job queue that the job is associated with.public String getJobQueue()
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
public JobDetail withJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
jobQueue
- The Amazon Resource Name (ARN) of the job queue that the job is associated with.public void setStatus(String status)
The current status for the job.
If your jobs don't progress to STARTING
, see Jobs stuck
in RUNNABLE status in the troubleshooting section of the Batch User Guide.
status
- The current status for the job.
If your jobs don't progress to STARTING
, see Jobs
stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
JobStatus
public String getStatus()
The current status for the job.
If your jobs don't progress to STARTING
, see Jobs stuck
in RUNNABLE status in the troubleshooting section of the Batch User Guide.
If your jobs don't progress to STARTING
, see Jobs
stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
JobStatus
public JobDetail withStatus(String status)
The current status for the job.
If your jobs don't progress to STARTING
, see Jobs stuck
in RUNNABLE status in the troubleshooting section of the Batch User Guide.
status
- The current status for the job.
If your jobs don't progress to STARTING
, see Jobs
stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
JobStatus
public void setStatus(JobStatus status)
The current status for the job.
If your jobs don't progress to STARTING
, see Jobs stuck
in RUNNABLE status in the troubleshooting section of the Batch User Guide.
status
- The current status for the job.
If your jobs don't progress to STARTING
, see Jobs
stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
JobStatus
public JobDetail withStatus(JobStatus status)
The current status for the job.
If your jobs don't progress to STARTING
, see Jobs stuck
in RUNNABLE status in the troubleshooting section of the Batch User Guide.
status
- The current status for the job.
If your jobs don't progress to STARTING
, see Jobs
stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.
JobStatus
public void setShareIdentifier(String shareIdentifier)
The share identifier for the job.
shareIdentifier
- The share identifier for the job.public String getShareIdentifier()
The share identifier for the job.
public JobDetail withShareIdentifier(String shareIdentifier)
The share identifier for the job.
shareIdentifier
- The share identifier for the job.public void setSchedulingPriority(Integer schedulingPriority)
The scheduling policy 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.
schedulingPriority
- The scheduling policy 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()
The scheduling policy 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 JobDetail withSchedulingPriority(Integer schedulingPriority)
The scheduling policy 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.
schedulingPriority
- The scheduling policy 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 List<AttemptDetail> getAttempts()
A list of job attempts that are associated with this job.
public void setAttempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
attempts
- A list of job attempts that are associated with this job.public JobDetail withAttempts(AttemptDetail... attempts)
A list of job attempts that are associated with this job.
NOTE: This method appends the values to the existing list (if any). Use
setAttempts(java.util.Collection)
or withAttempts(java.util.Collection)
if you want to override
the existing values.
attempts
- A list of job attempts that are associated with this job.public JobDetail withAttempts(Collection<AttemptDetail> attempts)
A list of job attempts that are associated with this job.
attempts
- A list of job attempts that are associated with this job.public void setStatusReason(String statusReason)
A short, human-readable string to provide more details for the current status of the job.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient capacity to
service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected instances
that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the service
role permissions.
statusReason
- A short, human-readable string to provide more details for the current status of the job.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient capacity
to service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected
instances that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the
service role permissions.
public String getStatusReason()
A short, human-readable string to provide more details for the current status of the job.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient capacity to
service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected instances
that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the service
role permissions.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient
capacity to service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected
instances that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the
service role permissions.
public JobDetail withStatusReason(String statusReason)
A short, human-readable string to provide more details for the current status of the job.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient capacity to
service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected instances
that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the service
role permissions.
statusReason
- A short, human-readable string to provide more details for the current status of the job.
CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY
- All compute environments have insufficient capacity
to service the job.
MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE
- All compute environments have a
maxVcpu
setting that is smaller than the job requirements.
MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT
- All compute environments have no connected
instances that meet the job requirements.
MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS
- All compute environments have problems with the
service role permissions.
public void setCreatedAt(Long createdAt)
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
is when the job entered the SUBMITTED
state. This is specifically at the time SubmitJob was called. For
array child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
createdAt
- The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array
jobs, this is when the job entered the SUBMITTED
state. This is specifically at the time SubmitJob was called.
For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.public Long getCreatedAt()
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
is when the job entered the SUBMITTED
state. This is specifically at the time SubmitJob was called. For
array child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
SUBMITTED
state. This is specifically at the time SubmitJob was called.
For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.public JobDetail withCreatedAt(Long createdAt)
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
is when the job entered the SUBMITTED
state. This is specifically at the time SubmitJob was called. For
array child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
createdAt
- The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array
jobs, this is when the job entered the SUBMITTED
state. This is specifically at the time SubmitJob was called.
For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.public void setRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
retryStrategy
- The retry strategy to use for this job if an attempt fails.public RetryStrategy getRetryStrategy()
The retry strategy to use for this job if an attempt fails.
public JobDetail withRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
retryStrategy
- The retry strategy to use for this job if an attempt fails.public void setStartedAt(Long startedAt)
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
transitioned from the STARTING
state to the RUNNING
state.
startedAt
- The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
transitioned from the STARTING
state to the RUNNING
state.public Long getStartedAt()
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
transitioned from the STARTING
state to the RUNNING
state.
STARTING
state to the RUNNING
state.public JobDetail withStartedAt(Long startedAt)
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
transitioned from the STARTING
state to the RUNNING
state.
startedAt
- The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
transitioned from the STARTING
state to the RUNNING
state.public void setStoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.
stoppedAt
- The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.public Long getStoppedAt()
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.
RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.public JobDetail withStoppedAt(Long stoppedAt)
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.
stoppedAt
- The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
transitioned from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
.public List<JobDependency> getDependsOn()
A list of job IDs that this job depends on.
public void setDependsOn(Collection<JobDependency> dependsOn)
A list of job IDs that this job depends on.
dependsOn
- A list of job IDs that this job depends on.public JobDetail withDependsOn(JobDependency... dependsOn)
A list of job IDs that this job depends on.
NOTE: This method appends the values to the existing list (if any). Use
setDependsOn(java.util.Collection)
or withDependsOn(java.util.Collection)
if you want to
override the existing values.
dependsOn
- A list of job IDs that this job depends on.public JobDetail withDependsOn(Collection<JobDependency> dependsOn)
A list of job IDs that this job depends on.
dependsOn
- A list of job IDs that this job depends on.public void setJobDefinition(String jobDefinition)
The Amazon Resource Name (ARN) of the job definition that this job uses.
jobDefinition
- The Amazon Resource Name (ARN) of the job definition that this job uses.public String getJobDefinition()
The Amazon Resource Name (ARN) of the job definition that this job uses.
public JobDetail withJobDefinition(String jobDefinition)
The Amazon Resource Name (ARN) of the job definition that this job uses.
jobDefinition
- The Amazon Resource Name (ARN) of the job definition that this job uses.public Map<String,String> getParameters()
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
public void setParameters(Map<String,String> parameters)
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
parameters
- Additional parameters that are passed to the job that replace parameter substitution placeholders or
override any corresponding parameter defaults from the job definition.public JobDetail withParameters(Map<String,String> parameters)
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
parameters
- Additional parameters that are passed to the job that replace parameter substitution placeholders or
override any corresponding parameter defaults from the job definition.public JobDetail addParametersEntry(String key, String value)
public JobDetail clearParametersEntries()
public void setContainer(ContainerDetail container)
An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.
container
- An object that represents the details for the container that's associated with the job. If the details are
for a multiple-container job, this object will be empty.public ContainerDetail getContainer()
An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.
public JobDetail withContainer(ContainerDetail container)
An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.
container
- An object that represents the details for the container that's associated with the job. If the details are
for a multiple-container job, this object will be empty.public void setNodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
nodeDetails
- An object that represents the details of a node that's associated with a multi-node parallel job.public NodeDetails getNodeDetails()
An object that represents the details of a node that's associated with a multi-node parallel job.
public JobDetail withNodeDetails(NodeDetails nodeDetails)
An object that represents the details of a node that's associated with a multi-node parallel job.
nodeDetails
- An object that represents the details of a node that's associated with a multi-node parallel job.public void setNodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
nodeProperties
- An object that represents the node properties of a multi-node parallel job. This isn't applicable to jobs that are running on Fargate resources.
public NodeProperties getNodeProperties()
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
This isn't applicable to jobs that are running on Fargate resources.
public JobDetail withNodeProperties(NodeProperties nodeProperties)
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
nodeProperties
- An object that represents the node properties of a multi-node parallel job. This isn't applicable to jobs that are running on Fargate resources.
public void setArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
arrayProperties
- The array properties of the job, if it's an array job.public ArrayPropertiesDetail getArrayProperties()
The array properties of the job, if it's an array job.
public JobDetail withArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it's an array job.
arrayProperties
- The array properties of the job, if it's an array job.public void setTimeout(JobTimeout timeout)
The timeout configuration for the job.
timeout
- The timeout configuration for the job.public JobTimeout getTimeout()
The timeout configuration for the job.
public JobDetail withTimeout(JobTimeout timeout)
The timeout configuration for the job.
timeout
- The timeout configuration for the job.public Map<String,String> getTags()
The tags that are applied to the job.
public void setTags(Map<String,String> tags)
The tags that are applied to the job.
tags
- The tags that are applied to the job.public JobDetail withTags(Map<String,String> tags)
The tags that are applied to the job.
tags
- The tags that are applied to the job.public JobDetail clearTagsEntries()
public void setPropagateTags(Boolean 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.
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 Boolean getPropagateTags()
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.
FAILED
state.public JobDetail withPropagateTags(Boolean 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.
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 Boolean isPropagateTags()
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.
FAILED
state.public List<String> getPlatformCapabilities()
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specify FARGATE
.
EC2
. Jobs run on Fargate resources specify FARGATE
.PlatformCapability
public void setPlatformCapabilities(Collection<String> 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
.
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
.PlatformCapability
public JobDetail withPlatformCapabilities(String... 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
setPlatformCapabilities(java.util.Collection)
or withPlatformCapabilities(java.util.Collection)
if you want to override the existing values.
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
.PlatformCapability
public JobDetail withPlatformCapabilities(Collection<String> 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
.
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
.PlatformCapability
public JobDetail withPlatformCapabilities(PlatformCapability... 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
.
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
.PlatformCapability
public void setEksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
eksProperties
- An object with various properties that are specific to Amazon EKS based jobs.public EksPropertiesDetail getEksProperties()
An object with various properties that are specific to Amazon EKS based jobs.
public JobDetail withEksProperties(EksPropertiesDetail eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
eksProperties
- An object with various properties that are specific to Amazon EKS based jobs.public List<EksAttemptDetail> getEksAttempts()
A list of job attempts that are associated with this job.
public void setEksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
eksAttempts
- A list of job attempts that are associated with this job.public JobDetail withEksAttempts(EksAttemptDetail... eksAttempts)
A list of job attempts that are associated with this job.
NOTE: This method appends the values to the existing list (if any). Use
setEksAttempts(java.util.Collection)
or withEksAttempts(java.util.Collection)
if you want to
override the existing values.
eksAttempts
- A list of job attempts that are associated with this job.public JobDetail withEksAttempts(Collection<EksAttemptDetail> eksAttempts)
A list of job attempts that are associated with this job.
eksAttempts
- A list of job attempts that are associated with this job.public void setEcsProperties(EcsPropertiesDetail ecsProperties)
An object with properties that are specific to Amazon ECS-based jobs.
ecsProperties
- An object with properties that are specific to Amazon ECS-based jobs.public EcsPropertiesDetail getEcsProperties()
An object with properties that are specific to Amazon ECS-based jobs.
public JobDetail withEcsProperties(EcsPropertiesDetail ecsProperties)
An object with properties that are specific to Amazon ECS-based jobs.
ecsProperties
- An object with properties that are specific to Amazon ECS-based jobs.public void setIsCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
isCancelled
- Indicates whether the job is canceled.public Boolean getIsCancelled()
Indicates whether the job is canceled.
public JobDetail withIsCancelled(Boolean isCancelled)
Indicates whether the job is canceled.
isCancelled
- Indicates whether the job is canceled.public Boolean isCancelled()
Indicates whether the job is canceled.
public void setIsTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
isTerminated
- Indicates whether the job is terminated.public Boolean getIsTerminated()
Indicates whether the job is terminated.
public JobDetail withIsTerminated(Boolean isTerminated)
Indicates whether the job is terminated.
isTerminated
- Indicates whether the job is terminated.public Boolean isTerminated()
Indicates whether the job is terminated.
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.