Class Job

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

The properties of a job returned by the Search API.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      The name of the job.

      Returns:
      The name of the job.

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the job.

      Returns:
      The Amazon Resource Name (ARN) of the job.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role associated with the job.

      Returns:
      The ARN of the IAM role associated with the job.

    • jobCategory

      public final JobCategory jobCategory()

      The category of the job.

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

      Returns:
      The category of the job.
      See Also:

    • jobCategoryAsString

      public final String jobCategoryAsString()

      The category of the job.

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

      Returns:
      The category of the job.
      See Also:

    • jobConfigSchemaVersion

      public final String jobConfigSchemaVersion()

      The schema version used for the job configuration document.

      Returns:
      The schema version used for the job configuration document.

    • jobConfigDocument

      public final String jobConfigDocument()

      The JSON configuration document for the job.

      Returns:
      The JSON configuration document for the job.

    • creationTime

      public final Instant creationTime()

      The date and time that the job was created.

      Returns:
      The date and time that the job was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time that the job was last modified.

      Returns:
      The date and time that the job was last modified.

    • endTime

      public final Instant endTime()

      The date and time that the job ended.

      Returns:
      The date and time that the job ended.

    • jobStatus

      public final JobStatus jobStatus()

      The current status of the job.

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

      Returns:
      The current status of the job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the job.

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

      Returns:
      The current status of the job.
      See Also:

    • secondaryStatus

      public final JobSecondaryStatus secondaryStatus()

      The detailed secondary status of the job, providing more granular information about the job's progress.

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

      Returns:
      The detailed secondary status of the job, providing more granular information about the job's progress.
      See Also:

    • secondaryStatusAsString

      public final String secondaryStatusAsString()

      The detailed secondary status of the job, providing more granular information about the job's progress.

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

      Returns:
      The detailed secondary status of the job, providing more granular information about the job's progress.
      See Also:

    • hasSecondaryStatusTransitions

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

    • secondaryStatusTransitions

      public final List<JobSecondaryStatusTransition> secondaryStatusTransitions()

      A list of secondary status transitions for the job, with timestamps and optional status messages.

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

      Returns:
      A list of secondary status transitions for the job, with timestamps and optional status messages.

    • failureReason

      public final String failureReason()

      If the job failed, the reason it failed.

      Returns:
      If the job failed, the reason it failed.

    • 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 List<Tag> tags()

      The tags associated with 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 hasTags() method.

      Returns:
      The tags associated with the job.

    • toBuilder

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

    • builder

      public static Job.Builder builder()

    • serializableBuilderClass

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