Class GetJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.deadline.model.DeadlineResponse
software.amazon.awssdk.services.deadline.model.GetJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetJobResponse.Builder,GetJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetJobResponse extends DeadlineResponse implements ToCopyableBuilder<GetJobResponse.Builder,GetJobResponse>

  • Method Details

    • jobId

      public final String jobId()

      The job ID.

      Returns:
      The job ID.

    • name

      public final String name()

      The name of the job.

      Returns:
      The name of the job.

    • lifecycleStatus

      public final JobLifecycleStatus lifecycleStatus()

      The life cycle status for the job.

      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 for the job.
      See Also:

    • lifecycleStatusAsString

      public final String lifecycleStatusAsString()

      The life cycle status for the job.

      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 for the job.
      See Also:

    • lifecycleStatusMessage

      public final String lifecycleStatusMessage()

      A message that communicates the status of the life cycle for the job.

      Returns:
      A message that communicates the status of the life cycle for the job.

    • 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.

      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.
      See Also:

    • taskRunStatusAsString

      public final String taskRunStatusAsString()

      The task run status for the job.

      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.
      See Also:

    • targetTaskRunStatus

      public final JobTargetTaskRunStatus targetTaskRunStatus()

      The task status with which the job started.

      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 with which the job started.
      See Also:

    • targetTaskRunStatusAsString

      public final String targetTaskRunStatusAsString()

      The task status with which the job started.

      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 with which the job started.
      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.

    • storageProfileId

      public final String storageProfileId()

      The storage profile ID associated with the job.

      Returns:
      The storage profile ID associated with the job.

    • 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 per failed tasks.

      Returns:
      The maximum number of retries per failed tasks.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters 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.

    • parameters

      public final Map<String,JobParameter> parameters()

      The parameters for 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 hasParameters() method.

      Returns:
      The parameters for the job.

    • attachments

      public final Attachments attachments()

      The attachments for the job.

      Returns:
      The attachments for the job.

    • description

      public final String description()

      The description of the job.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The description of the job.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • 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.

      If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

      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.

      If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

    • sourceJobId

      public final String sourceJobId()

      The job ID for the source job.

      Returns:
      The job ID for the source job.

    • toBuilder

      public GetJobResponse.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<GetJobResponse.Builder,GetJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.