JobSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.deadline.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

A summary of job details.

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`	`addTaskRunStatusCountsEntry(String key, Integer value)` Add a single TaskRunStatusCounts entry
`JobSummary`	`clearTaskRunStatusCountsEntries()` Removes all the entries added into TaskRunStatusCounts.
`JobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The date and time the resource was created.
`String`	`getCreatedBy()` The user or system that created this resource.
`Date`	`getEndedAt()` The date and time the resource ended running.
`String`	`getJobId()` The job ID.
`String`	`getLifecycleStatus()` The life cycle status.
`String`	`getLifecycleStatusMessage()` The life cycle status message.
`Integer`	`getMaxFailedTasksCount()` The number of task failures before the job stops running and is marked as `FAILED`.
`Integer`	`getMaxRetriesPerTask()` The maximum number of retries for a job.
`String`	`getName()` The job name.
`Integer`	`getPriority()` The job priority.
`Date`	`getStartedAt()` The date and time the resource started running.
`String`	`getTargetTaskRunStatus()` The task status to start with on the job.
`String`	`getTaskRunStatus()` The task run status for the job.
`Map<String,Integer>`	`getTaskRunStatusCounts()` The number of tasks running on the job.
`Date`	`getUpdatedAt()` The date and time the resource was updated.
`String`	`getUpdatedBy()` The user or system that updated this resource.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedAt(Date createdAt)` The date and time the resource was created.
`void`	`setCreatedBy(String createdBy)` The user or system that created this resource.
`void`	`setEndedAt(Date endedAt)` The date and time the resource ended running.
`void`	`setJobId(String jobId)` The job ID.
`void`	`setLifecycleStatus(String lifecycleStatus)` The life cycle status.
`void`	`setLifecycleStatusMessage(String lifecycleStatusMessage)` The life cycle status message.
`void`	`setMaxFailedTasksCount(Integer maxFailedTasksCount)` The number of task failures before the job stops running and is marked as `FAILED`.
`void`	`setMaxRetriesPerTask(Integer maxRetriesPerTask)` The maximum number of retries for a job.
`void`	`setName(String name)` The job name.
`void`	`setPriority(Integer priority)` The job priority.
`void`	`setStartedAt(Date startedAt)` The date and time the resource started running.
`void`	`setTargetTaskRunStatus(String targetTaskRunStatus)` The task status to start with on the job.
`void`	`setTaskRunStatus(String taskRunStatus)` The task run status for the job.
`void`	`setTaskRunStatusCounts(Map<String,Integer> taskRunStatusCounts)` The number of tasks running on the job.
`void`	`setUpdatedAt(Date updatedAt)` The date and time the resource was updated.
`void`	`setUpdatedBy(String updatedBy)` The user or system that updated this resource.
`String`	`toString()` Returns a string representation of this object.
`JobSummary`	`withCreatedAt(Date createdAt)` The date and time the resource was created.
`JobSummary`	`withCreatedBy(String createdBy)` The user or system that created this resource.
`JobSummary`	`withEndedAt(Date endedAt)` The date and time the resource ended running.
`JobSummary`	`withJobId(String jobId)` The job ID.
`JobSummary`	`withLifecycleStatus(JobLifecycleStatus lifecycleStatus)` The life cycle status.
`JobSummary`	`withLifecycleStatus(String lifecycleStatus)` The life cycle status.
`JobSummary`	`withLifecycleStatusMessage(String lifecycleStatusMessage)` The life cycle status message.
`JobSummary`	`withMaxFailedTasksCount(Integer maxFailedTasksCount)` The number of task failures before the job stops running and is marked as `FAILED`.
`JobSummary`	`withMaxRetriesPerTask(Integer maxRetriesPerTask)` The maximum number of retries for a job.
`JobSummary`	`withName(String name)` The job name.
`JobSummary`	`withPriority(Integer priority)` The job priority.
`JobSummary`	`withStartedAt(Date startedAt)` The date and time the resource started running.
`JobSummary`	`withTargetTaskRunStatus(JobTargetTaskRunStatus targetTaskRunStatus)` The task status to start with on the job.
`JobSummary`	`withTargetTaskRunStatus(String targetTaskRunStatus)` The task status to start with on the job.
`JobSummary`	`withTaskRunStatus(String taskRunStatus)` The task run status for the job.
`JobSummary`	`withTaskRunStatus(TaskRunStatus taskRunStatus)` The task run status for the job.
`JobSummary`	`withTaskRunStatusCounts(Map<String,Integer> taskRunStatusCounts)` The number of tasks running on the job.
`JobSummary`	`withUpdatedAt(Date updatedAt)` The date and time the resource was updated.
`JobSummary`	`withUpdatedBy(String updatedBy)` The user or system that updated this resource.

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

- Constructor Detail
  - JobSummary
```
public JobSummary()
```
- Method Detail
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time the resource was created.
    
    Parameters:
    
    createdAt - The date and time the resource was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date and time the resource was created.
    
    Returns:
    
    The date and time the resource was created.
  - withCreatedAt
```
public JobSummary withCreatedAt(Date createdAt)
```
    The date and time the resource was created.
    
    Parameters:
    
    createdAt - The date and time the resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    The user or system that created this resource.
    
    Parameters:
    
    createdBy - The user or system that created this resource.
  - getCreatedBy
```
public String getCreatedBy()
```
    The user or system that created this resource.
    
    Returns:
    
    The user or system that created this resource.
  - withCreatedBy
```
public JobSummary withCreatedBy(String createdBy)
```
    The user or system that created this resource.
    
    Parameters:
    
    createdBy - The user or system that created this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndedAt
```
public void setEndedAt(Date endedAt)
```
    The date and time the resource ended running.
    
    Parameters:
    
    endedAt - The date and time the resource ended running.
  - getEndedAt
```
public Date getEndedAt()
```
    The date and time the resource ended running.
    
    Returns:
    
    The date and time the resource ended running.
  - withEndedAt
```
public JobSummary withEndedAt(Date endedAt)
```
    The date and time the resource ended running.
    
    Parameters:
    
    endedAt - The date and time the resource ended running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The job ID.
    
    Parameters:
    
    jobId - The job ID.
  - getJobId
```
public String getJobId()
```
    The job ID.
    
    Returns:
    
    The job ID.
  - withJobId
```
public JobSummary withJobId(String jobId)
```
    The job ID.
    
    Parameters:
    
    jobId - The job ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycleStatus
```
public void setLifecycleStatus(String lifecycleStatus)
```
    The life cycle status.
    
    Parameters:
    
    lifecycleStatus - The life cycle status.
    
    See Also:
    
    JobLifecycleStatus
  - getLifecycleStatus
```
public String getLifecycleStatus()
```
    The life cycle status.
    
    Returns:
    
    The life cycle status.
    
    See Also:
    
    JobLifecycleStatus
  - withLifecycleStatus
```
public JobSummary withLifecycleStatus(String lifecycleStatus)
```
    The life cycle status.
    
    Parameters:
    
    lifecycleStatus - The life cycle status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobLifecycleStatus
  - withLifecycleStatus
```
public JobSummary withLifecycleStatus(JobLifecycleStatus lifecycleStatus)
```
    The life cycle status.
    
    Parameters:
    
    lifecycleStatus - The life cycle status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobLifecycleStatus
  - setLifecycleStatusMessage
```
public void setLifecycleStatusMessage(String lifecycleStatusMessage)
```
    The life cycle status message.
    
    Parameters:
    
    lifecycleStatusMessage - The life cycle status message.
  - getLifecycleStatusMessage
```
public String getLifecycleStatusMessage()
```
    The life cycle status message.
    
    Returns:
    
    The life cycle status message.
  - withLifecycleStatusMessage
```
public JobSummary withLifecycleStatusMessage(String lifecycleStatusMessage)
```
    The life cycle status message.
    
    Parameters:
    
    lifecycleStatusMessage - The life cycle status message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxFailedTasksCount
```
public void setMaxFailedTasksCount(Integer maxFailedTasksCount)
```
    The number of task failures before the job stops running and is marked as FAILED.
    
    Parameters:
    
    maxFailedTasksCount - The number of task failures before the job stops running and is marked as FAILED.
  - getMaxFailedTasksCount
```
public Integer getMaxFailedTasksCount()
```
    The number of task failures before the job stops running and is marked as FAILED.
    
    Returns:
    
    The number of task failures before the job stops running and is marked as FAILED.
  - withMaxFailedTasksCount
```
public JobSummary withMaxFailedTasksCount(Integer maxFailedTasksCount)
```
    The number of task failures before the job stops running and is marked as FAILED.
    
    Parameters:
    
    maxFailedTasksCount - The number of task failures before the job stops running and is marked as FAILED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetriesPerTask
```
public void setMaxRetriesPerTask(Integer maxRetriesPerTask)
```
    The maximum number of retries for a job.
    
    Parameters:
    
    maxRetriesPerTask - The maximum number of retries for a job.
  - getMaxRetriesPerTask
```
public Integer getMaxRetriesPerTask()
```
    The maximum number of retries for a job.
    
    Returns:
    
    The maximum number of retries for a job.
  - withMaxRetriesPerTask
```
public JobSummary withMaxRetriesPerTask(Integer maxRetriesPerTask)
```
    The maximum number of retries for a job.
    
    Parameters:
    
    maxRetriesPerTask - The maximum number of retries for a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The job name.
    
    Parameters:
    
    name - The job name.
  - getName
```
public String getName()
```
    The job name.
    
    Returns:
    
    The job name.
  - withName
```
public JobSummary withName(String name)
```
    The job name.
    
    Parameters:
    
    name - The job name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The job priority.
    
    Parameters:
    
    priority - The job priority.
  - getPriority
```
public Integer getPriority()
```
    The job priority.
    
    Returns:
    
    The job priority.
  - withPriority
```
public JobSummary withPriority(Integer priority)
```
    The job priority.
    
    Parameters:
    
    priority - The job priority.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Date startedAt)
```
    The date and time the resource started running.
    
    Parameters:
    
    startedAt - The date and time the resource started running.
  - getStartedAt
```
public Date getStartedAt()
```
    The date and time the resource started running.
    
    Returns:
    
    The date and time the resource started running.
  - withStartedAt
```
public JobSummary withStartedAt(Date startedAt)
```
    The date and time the resource started running.
    
    Parameters:
    
    startedAt - The date and time the resource started running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetTaskRunStatus
```
public void setTargetTaskRunStatus(String targetTaskRunStatus)
```
    The task status to start with on the job.
    
    Parameters:
    
    targetTaskRunStatus - The task status to start with on the job.
    
    See Also:
    
    JobTargetTaskRunStatus
  - getTargetTaskRunStatus
```
public String getTargetTaskRunStatus()
```
    The task status to start with on the job.
    
    Returns:
    
    The task status to start with on the job.
    
    See Also:
    
    JobTargetTaskRunStatus
  - withTargetTaskRunStatus
```
public JobSummary withTargetTaskRunStatus(String targetTaskRunStatus)
```
    The task status to start with on the job.
    
    Parameters:
    
    targetTaskRunStatus - The task status to start with on the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobTargetTaskRunStatus
  - withTargetTaskRunStatus
```
public JobSummary withTargetTaskRunStatus(JobTargetTaskRunStatus targetTaskRunStatus)
```
    The task status to start with on the job.
    
    Parameters:
    
    targetTaskRunStatus - The task status to start with on the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobTargetTaskRunStatus
  - setTaskRunStatus
```
public void setTaskRunStatus(String taskRunStatus)
```
    The task run status for the job.
    - PENDING–pending and waiting for resources.
    - READY–ready to be processed.
    - ASSIGNED–assigned and will run next on a worker.
    - SCHEDULED–scheduled to be run on a worker.
    - INTERRUPTING–being interrupted.
    - RUNNING–running on a worker.
    - SUSPENDED–the task is suspended.
    - CANCELED–the task has been canceled.
    - FAILED–the task has failed.
    - SUCCEEDED–the task has succeeded.
    Parameters:
    taskRunStatus - The task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    See Also:
    
    TaskRunStatus
  - getTaskRunStatus
```
public String getTaskRunStatus()
```
    The task run status for the job.
    - PENDING–pending and waiting for resources.
    - READY–ready to be processed.
    - ASSIGNED–assigned and will run next on a worker.
    - SCHEDULED–scheduled to be run on a worker.
    - INTERRUPTING–being interrupted.
    - RUNNING–running on a worker.
    - SUSPENDED–the task is suspended.
    - CANCELED–the task has been canceled.
    - FAILED–the task has failed.
    - SUCCEEDED–the task has succeeded.
    Returns:
    The task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    See Also:
    
    TaskRunStatus
  - withTaskRunStatus
```
public JobSummary withTaskRunStatus(String taskRunStatus)
```
    The task run status for the job.
    - PENDING–pending and waiting for resources.
    - READY–ready to be processed.
    - ASSIGNED–assigned and will run next on a worker.
    - SCHEDULED–scheduled to be run on a worker.
    - INTERRUPTING–being interrupted.
    - RUNNING–running on a worker.
    - SUSPENDED–the task is suspended.
    - CANCELED–the task has been canceled.
    - FAILED–the task has failed.
    - SUCCEEDED–the task has succeeded.
    Parameters:
    taskRunStatus - The task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskRunStatus
  - withTaskRunStatus
```
public JobSummary withTaskRunStatus(TaskRunStatus taskRunStatus)
```
    The task run status for the job.
    - PENDING–pending and waiting for resources.
    - READY–ready to be processed.
    - ASSIGNED–assigned and will run next on a worker.
    - SCHEDULED–scheduled to be run on a worker.
    - INTERRUPTING–being interrupted.
    - RUNNING–running on a worker.
    - SUSPENDED–the task is suspended.
    - CANCELED–the task has been canceled.
    - FAILED–the task has failed.
    - SUCCEEDED–the task has succeeded.
    Parameters:
    taskRunStatus - The task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskRunStatus
  - getTaskRunStatusCounts
```
public Map<String,Integer> getTaskRunStatusCounts()
```
    The number of tasks running on the job.
    
    Returns:
    
    The number of tasks running on the job.
  - setTaskRunStatusCounts
```
public void setTaskRunStatusCounts(Map<String,Integer> taskRunStatusCounts)
```
    The number of tasks running on the job.
    
    Parameters:
    
    taskRunStatusCounts - The number of tasks running on the job.
  - withTaskRunStatusCounts
```
public JobSummary withTaskRunStatusCounts(Map<String,Integer> taskRunStatusCounts)
```
    The number of tasks running on the job.
    
    Parameters:
    
    taskRunStatusCounts - The number of tasks running on the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTaskRunStatusCountsEntry
```
public JobSummary addTaskRunStatusCountsEntry(String key,
                                              Integer value)
```
    Add a single TaskRunStatusCounts entry
    
    See Also:
    
    withTaskRunStatusCounts(java.util.Map<java.lang.String, java.lang.Integer>)
  - clearTaskRunStatusCountsEntries
```
public JobSummary clearTaskRunStatusCountsEntries()
```
    Removes all the entries added into TaskRunStatusCounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The date and time the resource was updated.
    
    Parameters:
    
    updatedAt - The date and time the resource was updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The date and time the resource was updated.
    
    Returns:
    
    The date and time the resource was updated.
  - withUpdatedAt
```
public JobSummary withUpdatedAt(Date updatedAt)
```
    The date and time the resource was updated.
    
    Parameters:
    
    updatedAt - The date and time the resource was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedBy
```
public void setUpdatedBy(String updatedBy)
```
    The user or system that updated this resource.
    
    Parameters:
    
    updatedBy - The user or system that updated this resource.
  - getUpdatedBy
```
public String getUpdatedBy()
```
    The user or system that updated this resource.
    
    Returns:
    
    The user or system that updated this resource.
  - withUpdatedBy
```
public JobSummary withUpdatedBy(String updatedBy)
```
    The user or system that updated this resource.
    
    Parameters:
    
    updatedBy - The user or system that updated this resource.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class JobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobSummary

Method Detail

setCreatedAt

getCreatedAt

withCreatedAt

setCreatedBy

getCreatedBy

withCreatedBy

setEndedAt

getEndedAt

withEndedAt

setJobId

getJobId

withJobId

setLifecycleStatus

getLifecycleStatus

withLifecycleStatus

withLifecycleStatus

setLifecycleStatusMessage

getLifecycleStatusMessage

withLifecycleStatusMessage

setMaxFailedTasksCount

getMaxFailedTasksCount

withMaxFailedTasksCount

setMaxRetriesPerTask

getMaxRetriesPerTask

withMaxRetriesPerTask

setName

getName

withName

setPriority

getPriority

withPriority

setStartedAt

getStartedAt

withStartedAt

setTargetTaskRunStatus

getTargetTaskRunStatus

withTargetTaskRunStatus

withTargetTaskRunStatus

setTaskRunStatus

getTaskRunStatus

withTaskRunStatus

withTaskRunStatus

getTaskRunStatusCounts

setTaskRunStatusCounts

withTaskRunStatusCounts

addTaskRunStatusCountsEntry

clearTaskRunStatusCountsEntries

setUpdatedAt

getUpdatedAt

withUpdatedAt

setUpdatedBy

getUpdatedBy

withUpdatedBy

toString

equals

hashCode

clone

marshall