JobDetail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.JobDetail

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobDetail
extends Object
implements Serializable, Cloneable, StructuredPojo

An object representing an Batch job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobDetail()

Constructors
Constructor and Description
`JobDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
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 is an array job.
`List<AttemptDetail>`	`getAttempts()` A list of job attempts associated with this job.
`ContainerDetail`	`getContainer()` An object representing the details of 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.
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the job.
`String`	`getJobDefinition()` The Amazon Resource Name (ARN) of the job definition that's used by this job.
`String`	`getJobId()` The ID for the job.
`String`	`getJobName()` The name of the job.
`String`	`getJobQueue()` The Amazon Resource Name (ARN) of the job queue that the job is associated with.
`NodeDetails`	`getNodeDetails()` An object representing the details of a node that's associated with a multi-node parallel job.
`NodeProperties`	`getNodeProperties()` An object representing the node properties of a multi-node parallel job.
`Map<String,String>`	`getParameters()` Additional parameters 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 (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`String`	`getStatus()` The current status for the job.
`String`	`getStatusReason()` A short, human-readable string to provide additional details about the current status of the job.
`Long`	`getStoppedAt()` The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`Map<String,String>`	`getTags()` The tags applied to the job.
`JobTimeout`	`getTimeout()` The timeout configuration for the job.
`int`	`hashCode()`
`Boolean`	`isPropagateTags()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArrayProperties(ArrayPropertiesDetail arrayProperties)` The array properties of the job, if it is an array job.
`void`	`setAttempts(Collection<AttemptDetail> attempts)` A list of job attempts associated with this job.
`void`	`setContainer(ContainerDetail container)` An object representing the details of 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`	`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's used by this job.
`void`	`setJobId(String jobId)` The ID for the job.
`void`	`setJobName(String jobName)` The name of the job.
`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 representing the details of a node that's associated with a multi-node parallel job.
`void`	`setNodeProperties(NodeProperties nodeProperties)` An object representing the node properties of a multi-node parallel job.
`void`	`setParameters(Map<String,String> parameters)` Additional parameters 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 (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`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 additional details about the current status of the job.
`void`	`setStoppedAt(Long stoppedAt)` The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`void`	`setTags(Map<String,String> tags)` The tags 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 is an array job.
`JobDetail`	`withAttempts(AttemptDetail... attempts)` A list of job attempts associated with this job.
`JobDetail`	`withAttempts(Collection<AttemptDetail> attempts)` A list of job attempts associated with this job.
`JobDetail`	`withContainer(ContainerDetail container)` An object representing the details of 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`	`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's used by this job.
`JobDetail`	`withJobId(String jobId)` The ID for the job.
`JobDetail`	`withJobName(String jobName)` The name of the job.
`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 representing the details of a node that's associated with a multi-node parallel job.
`JobDetail`	`withNodeProperties(NodeProperties nodeProperties)` An object representing the node properties of a multi-node parallel job.
`JobDetail`	`withParameters(Map<String,String> parameters)` Additional parameters 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 (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`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 additional details about the current status of the job.
`JobDetail`	`withStoppedAt(Long stoppedAt)` The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`JobDetail`	`withTags(Map<String,String> tags)` The tags applied to the job.
`JobDetail`	`withTimeout(JobTimeout timeout)` The timeout configuration for the job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobDetail
```
public JobDetail()
```
- Method Detail
  - setJobArn
```
public void setJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the job.
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the job.
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) of the job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job.
  - withJobArn
```
public JobDetail withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the job.
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the job.
    
    Parameters:
    
    jobName - The name of the job.
  - getJobName
```
public String getJobName()
```
    The name of the job.
    
    Returns:
    
    The name of the job.
  - withJobName
```
public JobDetail withJobName(String jobName)
```
    The name of the job.
    
    Parameters:
    
    jobName - The name of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The ID for the job.
    
    Parameters:
    
    jobId - The ID for the job.
  - getJobId
```
public String getJobId()
```
    The ID for the job.
    
    Returns:
    
    The ID for the job.
  - withJobId
```
public JobDetail withJobId(String jobId)
```
    The ID for the job.
    
    Parameters:
    
    jobId - The ID for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobQueue
```
public void setJobQueue(String jobQueue)
```
    The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Parameters:
    
    jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.
  - getJobQueue
```
public String getJobQueue()
```
    The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job queue that the job is associated with.
  - withJobQueue
```
public JobDetail withJobQueue(String jobQueue)
```
    The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Parameters:
    
    jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    JobStatus
  - getStatus
```
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.
    
    Returns:
    
    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.
    
    See Also:
    
    JobStatus
  - withStatus
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setStatus
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    JobStatus
  - withStatus
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setShareIdentifier
```
public void setShareIdentifier(String shareIdentifier)
```
    The share identifier for the job.
    
    Parameters:
    
    shareIdentifier - The share identifier for the job.
  - getShareIdentifier
```
public String getShareIdentifier()
```
    The share identifier for the job.
    
    Returns:
    
    The share identifier for the job.
  - withShareIdentifier
```
public JobDetail withShareIdentifier(String shareIdentifier)
```
    The share identifier for the job.
    
    Parameters:
    
    shareIdentifier - The share identifier for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedulingPriority
```
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.
    
    Parameters:
    
    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.
  - getSchedulingPriority
```
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.
    
    Returns:
    
    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.
  - withSchedulingPriority
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttempts
```
public List<AttemptDetail> getAttempts()
```
    A list of job attempts associated with this job.
    
    Returns:
    
    A list of job attempts associated with this job.
  - setAttempts
```
public void setAttempts(Collection<AttemptDetail> attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
  - withAttempts
```
public JobDetail withAttempts(AttemptDetail... attempts)
```
    A list of job attempts 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.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttempts
```
public JobDetail withAttempts(Collection<AttemptDetail> attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job.
  - getStatusReason
```
public String getStatusReason()
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Returns:
    
    A short, human-readable string to provide additional details about the current status of the job.
  - withStatusReason
```
public JobDetail withStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
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 (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.
    
    Parameters:
    
    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 (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.
  - getCreatedAt
```
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 (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.
    
    Returns:
    
    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 (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.
  - withCreatedAt
```
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 (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.
    
    Parameters:
    
    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 (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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryStrategy
```
public void setRetryStrategy(RetryStrategy retryStrategy)
```
    The retry strategy to use for this job if an attempt fails.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for this job if an attempt fails.
  - getRetryStrategy
```
public RetryStrategy getRetryStrategy()
```
    The retry strategy to use for this job if an attempt fails.
    
    Returns:
    
    The retry strategy to use for this job if an attempt fails.
  - withRetryStrategy
```
public JobDetail withRetryStrategy(RetryStrategy retryStrategy)
```
    The retry strategy to use for this job if an attempt fails.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for this job if an attempt fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Long startedAt)
```
    The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Parameters:
    
    startedAt - The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
  - getStartedAt
```
public Long getStartedAt()
```
    The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Returns:
    
    The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
  - withStartedAt
```
public JobDetail withStartedAt(Long startedAt)
```
    The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Parameters:
    
    startedAt - The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppedAt
```
public void setStoppedAt(Long stoppedAt)
```
    The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    
    Parameters:
    
    stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
  - getStoppedAt
```
public Long getStoppedAt()
```
    The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    
    Returns:
    
    The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
  - withStoppedAt
```
public JobDetail withStoppedAt(Long stoppedAt)
```
    The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    
    Parameters:
    
    stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDependsOn
```
public List<JobDependency> getDependsOn()
```
    A list of job IDs that this job depends on.
    
    Returns:
    
    A list of job IDs that this job depends on.
  - setDependsOn
```
public void setDependsOn(Collection<JobDependency> dependsOn)
```
    A list of job IDs that this job depends on.
    
    Parameters:
    
    dependsOn - A list of job IDs that this job depends on.
  - withDependsOn
```
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.
    
    Parameters:
    
    dependsOn - A list of job IDs that this job depends on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDependsOn
```
public JobDetail withDependsOn(Collection<JobDependency> dependsOn)
```
    A list of job IDs that this job depends on.
    
    Parameters:
    
    dependsOn - A list of job IDs that this job depends on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDefinition
```
public void setJobDefinition(String jobDefinition)
```
    The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Parameters:
    
    jobDefinition - The Amazon Resource Name (ARN) of the job definition that's used by this job.
  - getJobDefinition
```
public String getJobDefinition()
```
    The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job definition that's used by this job.
  - withJobDefinition
```
public JobDetail withJobDefinition(String jobDefinition)
```
    The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Parameters:
    
    jobDefinition - The Amazon Resource Name (ARN) of the job definition that's used by this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,String> getParameters()
```
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
  - withParameters
```
public JobDetail withParameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public JobDetail addParametersEntry(String key,
                                    String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public JobDetail clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainer
```
public void setContainer(ContainerDetail container)
```
    An object representing the details of the container that's associated with the job.
    
    Parameters:
    
    container - An object representing the details of the container that's associated with the job.
  - getContainer
```
public ContainerDetail getContainer()
```
    An object representing the details of the container that's associated with the job.
    
    Returns:
    
    An object representing the details of the container that's associated with the job.
  - withContainer
```
public JobDetail withContainer(ContainerDetail container)
```
    An object representing the details of the container that's associated with the job.
    
    Parameters:
    
    container - An object representing the details of the container that's associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNodeDetails
```
public void setNodeDetails(NodeDetails nodeDetails)
```
    An object representing the details of a node that's associated with a multi-node parallel job.
    
    Parameters:
    
    nodeDetails - An object representing the details of a node that's associated with a multi-node parallel job.
  - getNodeDetails
```
public NodeDetails getNodeDetails()
```
    An object representing the details of a node that's associated with a multi-node parallel job.
    
    Returns:
    
    An object representing the details of a node that's associated with a multi-node parallel job.
  - withNodeDetails
```
public JobDetail withNodeDetails(NodeDetails nodeDetails)
```
    An object representing the details of a node that's associated with a multi-node parallel job.
    
    Parameters:
    
    nodeDetails - An object representing the details of a node that's associated with a multi-node parallel job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNodeProperties
```
public void setNodeProperties(NodeProperties nodeProperties)
```
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Parameters:
    
    nodeProperties - An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
  - getNodeProperties
```
public NodeProperties getNodeProperties()
```
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Returns:
    
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
  - withNodeProperties
```
public JobDetail withNodeProperties(NodeProperties nodeProperties)
```
    An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Parameters:
    
    nodeProperties - An object representing the node properties of a multi-node parallel job.
    
    This isn't applicable to jobs that are running on Fargate resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArrayProperties
```
public void setArrayProperties(ArrayPropertiesDetail arrayProperties)
```
    The array properties of the job, if it is an array job.
    
    Parameters:
    
    arrayProperties - The array properties of the job, if it is an array job.
  - getArrayProperties
```
public ArrayPropertiesDetail getArrayProperties()
```
    The array properties of the job, if it is an array job.
    
    Returns:
    
    The array properties of the job, if it is an array job.
  - withArrayProperties
```
public JobDetail withArrayProperties(ArrayPropertiesDetail arrayProperties)
```
    The array properties of the job, if it is an array job.
    
    Parameters:
    
    arrayProperties - The array properties of the job, if it is an array job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeout
```
public void setTimeout(JobTimeout timeout)
```
    The timeout configuration for the job.
    
    Parameters:
    
    timeout - The timeout configuration for the job.
  - getTimeout
```
public JobTimeout getTimeout()
```
    The timeout configuration for the job.
    
    Returns:
    
    The timeout configuration for the job.
  - withTimeout
```
public JobDetail withTimeout(JobTimeout timeout)
```
    The timeout configuration for the job.
    
    Parameters:
    
    timeout - The timeout configuration for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags applied to the job.
    
    Returns:
    
    The tags applied to the job.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags applied to the job.
    
    Parameters:
    
    tags - The tags applied to the job.
  - withTags
```
public JobDetail withTags(Map<String,String> tags)
```
    The tags applied to the job.
    
    Parameters:
    
    tags - The tags applied to the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public JobDetail addTagsEntry(String key,
                              String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public JobDetail clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropagateTags
```
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 during task creation. 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.
    
    Parameters:
    
    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 during task creation. 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.
  - getPropagateTags
```
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 during task creation. 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.
    
    Returns:
    
    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 during task creation. 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.
  - withPropagateTags
```
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 during task creation. 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.
    
    Parameters:
    
    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 during task creation. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPropagateTags
```
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 during task creation. 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.
    
    Returns:
    
    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 during task creation. 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.
  - getPlatformCapabilities
```
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.
    
    Returns:
    
    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 Also:
    
    PlatformCapability
  - setPlatformCapabilities
```
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.
    
    Parameters:
    
    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 Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobDetail clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class JobDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobDetail

Method Detail

setJobArn

getJobArn

withJobArn

setJobName

getJobName

withJobName

setJobId

getJobId

withJobId

setJobQueue

getJobQueue

withJobQueue

setStatus

getStatus

withStatus

setStatus

withStatus

setShareIdentifier

getShareIdentifier

withShareIdentifier

setSchedulingPriority

getSchedulingPriority

withSchedulingPriority

getAttempts

setAttempts

withAttempts

withAttempts

setStatusReason

getStatusReason

withStatusReason

setCreatedAt

getCreatedAt

withCreatedAt

setRetryStrategy

getRetryStrategy

withRetryStrategy

setStartedAt

getStartedAt

withStartedAt

setStoppedAt

getStoppedAt

withStoppedAt

getDependsOn

setDependsOn

withDependsOn

withDependsOn

setJobDefinition

getJobDefinition

withJobDefinition

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setContainer

getContainer

withContainer

setNodeDetails

getNodeDetails

withNodeDetails

setNodeProperties

getNodeProperties

withNodeProperties

setArrayProperties

getArrayProperties

withArrayProperties

setTimeout

getTimeout

withTimeout

getTags

setTags

withTags