JobSummary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object representing summary details of a job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobSummary()

Constructors
Constructor and Description
`JobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`ArrayPropertiesSummary`	`getArrayProperties()` The array properties of the job, if it is an array job.
`ContainerSummary`	`getContainer()` An object representing the details of the container that's associated with the job.
`Long`	`getCreatedAt()` The Unix timestamp for when the job was created.
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the job.
`String`	`getJobId()` The ID of the job.
`String`	`getJobName()` The name of the job.
`NodePropertiesSummary`	`getNodeProperties()` The node properties for a single node in a job summary list.
`Long`	`getStartedAt()` The Unix timestamp 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 for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArrayProperties(ArrayPropertiesSummary arrayProperties)` The array properties of the job, if it is an array job.
`void`	`setContainer(ContainerSummary container)` An object representing the details of the container that's associated with the job.
`void`	`setCreatedAt(Long createdAt)` The Unix timestamp for when the job was created.
`void`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) of the job.
`void`	`setJobId(String jobId)` The ID of the job.
`void`	`setJobName(String jobName)` The name of the job.
`void`	`setNodeProperties(NodePropertiesSummary nodeProperties)` The node properties for a single node in a job summary list.
`void`	`setStartedAt(Long startedAt)` The Unix timestamp for when the job was started (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`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 for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).
`String`	`toString()` Returns a string representation of this object.
`JobSummary`	`withArrayProperties(ArrayPropertiesSummary arrayProperties)` The array properties of the job, if it is an array job.
`JobSummary`	`withContainer(ContainerSummary container)` An object representing the details of the container that's associated with the job.
`JobSummary`	`withCreatedAt(Long createdAt)` The Unix timestamp for when the job was created.
`JobSummary`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) of the job.
`JobSummary`	`withJobId(String jobId)` The ID of the job.
`JobSummary`	`withJobName(String jobName)` The name of the job.
`JobSummary`	`withNodeProperties(NodePropertiesSummary nodeProperties)` The node properties for a single node in a job summary list.
`JobSummary`	`withStartedAt(Long startedAt)` The Unix timestamp for when the job was started (when the job transitioned from the `STARTING` state to the `RUNNING` state).
`JobSummary`	`withStatus(JobStatus status)` The current status for the job.
`JobSummary`	`withStatus(String status)` The current status for the job.
`JobSummary`	`withStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job.
`JobSummary`	`withStoppedAt(Long stoppedAt)` The Unix timestamp for when the job was stopped (when the job transitioned from the `RUNNING` state to a terminal state, such as `SUCCEEDED` or `FAILED`).

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

- Constructor Detail
  - JobSummary
```
public JobSummary()
```
- 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 JobSummary 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.
  - setJobId
```
public void setJobId(String jobId)
```
    The ID of the job.
    
    Parameters:
    
    jobId - The ID of the job.
  - getJobId
```
public String getJobId()
```
    The ID of the job.
    
    Returns:
    
    The ID of the job.
  - withJobId
```
public JobSummary withJobId(String jobId)
```
    The ID of the job.
    
    Parameters:
    
    jobId - The ID 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 JobSummary 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.
  - setCreatedAt
```
public void setCreatedAt(Long createdAt)
```
    The Unix timestamp 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 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 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 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 JobSummary withCreatedAt(Long createdAt)
```
    The Unix timestamp 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 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.
  - setStatus
```
public void setStatus(String status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The current status for the job.
    
    Returns:
    
    The current status for the job.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobSummary withStatus(String status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobSummary withStatus(JobStatus status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - 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 JobSummary 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.
  - setStartedAt
```
public void setStartedAt(Long startedAt)
```
    The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
  - getStartedAt
```
public Long getStartedAt()
```
    The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    
    Returns:
    
    The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
  - withStartedAt
```
public JobSummary withStartedAt(Long startedAt)
```
    The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppedAt
```
public void setStoppedAt(Long stoppedAt)
```
    The Unix timestamp 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 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 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 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 JobSummary withStoppedAt(Long stoppedAt)
```
    The Unix timestamp 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 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.
  - setContainer
```
public void setContainer(ContainerSummary 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 ContainerSummary 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 JobSummary withContainer(ContainerSummary 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.
  - setArrayProperties
```
public void setArrayProperties(ArrayPropertiesSummary 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 ArrayPropertiesSummary 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 JobSummary withArrayProperties(ArrayPropertiesSummary 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.
  - setNodeProperties
```
public void setNodeProperties(NodePropertiesSummary nodeProperties)
```
    The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
    
    Parameters:
    
    nodeProperties - The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
  - getNodeProperties
```
public NodePropertiesSummary getNodeProperties()
```
    The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
    
    Returns:
    
    The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
  - withNodeProperties
```
public JobSummary withNodeProperties(NodePropertiesSummary nodeProperties)
```
    The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
    
    Parameters:
    
    nodeProperties - The node properties for a single node in a job summary list.
    
    This isn't applicable to jobs running on Fargate resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 JobSummary 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 JobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobSummary

Method Detail

setJobArn

getJobArn

withJobArn

setJobId

getJobId

withJobId

setJobName

getJobName

withJobName

setCreatedAt

getCreatedAt

withCreatedAt

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setStartedAt

getStartedAt

withStartedAt

setStoppedAt

getStoppedAt

withStoppedAt

setContainer

getContainer

withContainer

setArrayProperties

getArrayProperties

withArrayProperties

setNodeProperties

getNodeProperties

withNodeProperties

toString

equals

hashCode

clone

marshall