JobDetail (AWS Java SDK :: Services :: AWS Batch 2.7.10 API)

java.lang.Object
- software.amazon.awssdk.services.batch.model.JobDetail

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<JobDetail.Builder,JobDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobDetail.Builder,JobDetail>

An object representing an AWS Batch job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobDetail.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobDetail.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayPropertiesDetail`	`arrayProperties()` The array properties of the job, if it is an array job.
`List<AttemptDetail>`	`attempts()` A list of job attempts associated with this job.
`static JobDetail.Builder`	`builder()`
`ContainerDetail`	`container()` An object representing the details of the container that is associated with the job.
`Long`	`createdAt()` The Unix timestamp (in seconds and milliseconds) for when the job was created.
`List<JobDependency>`	`dependsOn()` A list of job names or IDs on which this job depends.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`jobDefinition()` The job definition that is used by this job.
`String`	`jobId()` The ID for the job.
`String`	`jobName()` The name of the job.
`String`	`jobQueue()` The Amazon Resource Name (ARN) of the job queue with which the job is associated.
`NodeDetails`	`nodeDetails()` An object representing the details of a node that is associated with a multi-node parallel job.
`NodeProperties`	`nodeProperties()` An object representing the node properties of a multi-node parallel job.
`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.
`RetryStrategy`	`retryStrategy()` The retry strategy to use for this job if an attempt fails.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobDetail.Builder>`	`serializableBuilderClass()`
`Long`	`startedAt()` The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`JobStatus`	`status()` The current status for the job.
`String`	`statusAsString()` The current status for the job.
`String`	`statusReason()` A short, human-readable string to provide additional details about the current status of the job.
`Long`	`stoppedAt()` The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`JobTimeout`	`timeout()` The timeout configuration for the job.
`JobDetail.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobName
```
public String jobName()
```
    The name of the job.
    
    Returns:
    
    The name of the job.
  - jobId
```
public String jobId()
```
    The ID for the job.
    
    Returns:
    
    The ID for the job.
  - jobQueue
```
public String jobQueue()
```
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
  - status
```
public JobStatus status()
```
    The current status for the job.
    
    If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status for the job.
    
    If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
    
    See Also:
    
    JobStatus
  - statusAsString
```
public String statusAsString()
```
    The current status for the job.
    
    If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status for the job.
    
    If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
    
    See Also:
    
    JobStatus
  - attempts
```
public List<AttemptDetail> attempts()
```
    A list of job attempts associated with this job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of job attempts associated with this job.
  - statusReason
```
public String statusReason()
```
    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.
  - createdAt
```
public Long createdAt()
```
    The Unix timestamp (in seconds and 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 seconds and 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.
  - retryStrategy
```
public RetryStrategy retryStrategy()
```
    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.
  - startedAt
```
public Long startedAt()
```
    The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    
    Returns:
    
    The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
  - stoppedAt
```
public Long stoppedAt()
```
    The Unix timestamp (in seconds and 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 seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
  - dependsOn
```
public List<JobDependency> dependsOn()
```
    A list of job names or IDs on which this job depends.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of job names or IDs on which this job depends.
  - jobDefinition
```
public String jobDefinition()
```
    The job definition that is used by this job.
    
    Returns:
    
    The job definition that is used by this job.
  - parameters
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
  - container
```
public ContainerDetail container()
```
    An object representing the details of the container that is associated with the job.
    
    Returns:
    
    An object representing the details of the container that is associated with the job.
  - nodeDetails
```
public NodeDetails nodeDetails()
```
    An object representing the details of a node that is associated with a multi-node parallel job.
    
    Returns:
    
    An object representing the details of a node that is associated with a multi-node parallel job.
  - nodeProperties
```
public NodeProperties nodeProperties()
```
    An object representing the node properties of a multi-node parallel job.
    
    Returns:
    
    An object representing the node properties of a multi-node parallel job.
  - arrayProperties
```
public ArrayPropertiesDetail arrayProperties()
```
    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.
  - timeout
```
public JobTimeout timeout()
```
    The timeout configuration for the job.
    
    Returns:
    
    The timeout configuration for the job.
  - toBuilder
```
public JobDetail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobDetail.Builder,JobDetail>
  - builder
```
public static JobDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobDetail.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobName

jobId

jobQueue

status

statusAsString

attempts

statusReason

createdAt

retryStrategy

startedAt

stoppedAt

dependsOn

jobDefinition

parameters

container

nodeDetails

nodeProperties

arrayProperties

timeout

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields