Class JobRun

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

This entity describes a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the job run.

      Returns:
      The ID of the job run.

    • name

      public final String name()

      The name of the job run.

      Returns:
      The name of the job run.

    • virtualClusterId

      public final String virtualClusterId()

      The ID of the job run's virtual cluster.

      Returns:
      The ID of the job run's virtual cluster.

    • arn

      public final String arn()

      The ARN of job run.

      Returns:
      The ARN of job run.

    • state

      public final JobRunState state()

      The state of the job run.

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

      Returns:
      The state of the job run.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the job run.

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

      Returns:
      The state of the job run.
      See Also:

    • clientToken

      public final String clientToken()

      The client token used to start a job run.

      Returns:
      The client token used to start a job run.

    • executionRoleArn

      public final String executionRoleArn()

      The execution role ARN of the job run.

      Returns:
      The execution role ARN of the job run.

    • releaseLabel

      public final String releaseLabel()

      The release version of Amazon EMR.

      Returns:
      The release version of Amazon EMR.

    • configurationOverrides

      public final ConfigurationOverrides configurationOverrides()

      The configuration settings that are used to override default configuration.

      Returns:
      The configuration settings that are used to override default configuration.

    • jobDriver

      public final JobDriver jobDriver()

      Parameters of job driver for the job run.

      Returns:
      Parameters of job driver for the job run.

    • createdAt

      public final Instant createdAt()

      The date and time when the job run was created.

      Returns:
      The date and time when the job run was created.

    • createdBy

      public final String createdBy()

      The user who created the job run.

      Returns:
      The user who created the job run.

    • finishedAt

      public final Instant finishedAt()

      The date and time when the job run has finished.

      Returns:
      The date and time when the job run has finished.

    • stateDetails

      public final String stateDetails()

      Additional details of the job run state.

      Returns:
      Additional details of the job run state.

    • failureReason

      public final FailureReason failureReason()

      The reasons why the job run has failed.

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

      Returns:
      The reasons why the job run has failed.
      See Also:

    • failureReasonAsString

      public final String failureReasonAsString()

      The reasons why the job run has failed.

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

      Returns:
      The reasons why the job run has failed.
      See Also:

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The assigned tags of the job run.

      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 hasTags() method.

      Returns:
      The assigned tags of the job run.

    • retryPolicyConfiguration

      public final RetryPolicyConfiguration retryPolicyConfiguration()

      The configuration of the retry policy that the job runs on.

      Returns:
      The configuration of the retry policy that the job runs on.

    • retryPolicyExecution

      public final RetryPolicyExecution retryPolicyExecution()

      The current status of the retry policy executed on the job.

      Returns:
      The current status of the retry policy executed on the job.

    • toBuilder

      public JobRun.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<JobRun.Builder,JobRun>
      Returns:
      a builder for type T

    • builder

      public static JobRun.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobRun.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.