Class JobSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.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>

Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job.

See Also:

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the job.

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

    • jobName

      public final String jobName()

      The name of the job.

      Returns:
      The name of 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:

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

    • jobSecondaryStatus

      public final JobSecondaryStatus jobSecondaryStatus()

      The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

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

      Returns:
      The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.
      See Also:

    • jobSecondaryStatusAsString

      public final String jobSecondaryStatusAsString()

      The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

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

      Returns:
      The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.
      See Also:

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

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