Class JobSummary

java.lang.Object
software.amazon.awssdk.services.deadline.model.JobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JobSummary.Builder,JobSummary>
@Generated("software.amazon.awssdk:codegen") public final class JobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobSummary.Builder,JobSummary>

A summary of job details.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The job ID.

      Returns:
      The job ID.

    • name

      public final String name()

      The job name.

      Returns:
      The job name.

    • lifecycleStatus

      public final JobLifecycleStatus lifecycleStatus()

      The life cycle status.

      If the service returns an enum value that is not available in the current SDK version, lifecycleStatus will return JobLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStatusAsString().

      Returns:
      The life cycle status.
      See Also:

    • lifecycleStatusAsString

      public final String lifecycleStatusAsString()

      The life cycle status.

      If the service returns an enum value that is not available in the current SDK version, lifecycleStatus will return JobLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStatusAsString().

      Returns:
      The life cycle status.
      See Also:

    • lifecycleStatusMessage

      public final String lifecycleStatusMessage()

      The life cycle status message.

      Returns:
      The life cycle status message.

    • priority

      public final Integer priority()

      The job priority.

      Returns:
      The job priority.

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • createdBy

      public final String createdBy()

      The user or system that created this resource.

      Returns:
      The user or system that created this resource.

    • updatedAt

      public final Instant updatedAt()

      The date and time the resource was updated.

      Returns:
      The date and time the resource was updated.

    • updatedBy

      public final String updatedBy()

      The user or system that updated this resource.

      Returns:
      The user or system that updated this resource.

    • startedAt

      public final Instant startedAt()

      The date and time the resource started running.

      Returns:
      The date and time the resource started running.

    • endedAt

      public final Instant endedAt()

      The date and time the resource ended running.

      Returns:
      The date and time the resource ended running.

    • taskRunStatus

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, taskRunStatus will return TaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskRunStatusAsString().

      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:

    • taskRunStatusAsString

      public final String taskRunStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, taskRunStatus will return TaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskRunStatusAsString().

      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:

    • targetTaskRunStatus

      public final JobTargetTaskRunStatus targetTaskRunStatus()

      The task status to start with on the job.

      If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return JobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().

      Returns:
      The task status to start with on the job.
      See Also:

    • targetTaskRunStatusAsString

      public final String targetTaskRunStatusAsString()

      The task status to start with on the job.

      If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return JobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().

      Returns:
      The task status to start with on the job.
      See Also:

    • taskRunStatusCounts

      public final Map<TaskRunStatus,Integer> taskRunStatusCounts()

      The number of tasks running on the job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaskRunStatusCounts() method.

      Returns:
      The number of tasks running on the job.

    • hasTaskRunStatusCounts

      public final boolean hasTaskRunStatusCounts()
      For responses, this returns true if the service returned a value for the TaskRunStatusCounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • taskRunStatusCountsAsStrings

      public final Map<String,Integer> taskRunStatusCountsAsStrings()

      The number of tasks running on the job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaskRunStatusCounts() method.

      Returns:
      The number of tasks running on the job.

    • taskFailureRetryCount

      public final Integer taskFailureRetryCount()

      The total number of times tasks from the job failed and were retried.

      Returns:
      The total number of times tasks from the job failed and were retried.

    • maxFailedTasksCount

      public final Integer maxFailedTasksCount()

      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.

    • maxRetriesPerTask

      public final Integer maxRetriesPerTask()

      The maximum number of retries for a job.

      Returns:
      The maximum number of retries for a job.

    • maxWorkerCount

      public final Integer maxWorkerCount()

      The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, the default is -1.

      Returns:
      The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, the default is -1.

    • sourceJobId

      public final String sourceJobId()

      The job ID for the source job.

      Returns:
      The job ID for the source job.

    • toBuilder

      public JobSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>
      Returns:
      a builder for type T

    • builder

      public static JobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.