Package software.amazon.awssdk.services.sagemaker.model

Class TransformJobSummary

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

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

See Also:

  • Method Details

    • transformJobName

      public final String transformJobName()

      The name of the transform job.

      Returns:
      The name of the transform job.

    • transformJobArn

      public final String transformJobArn()

      The Amazon Resource Name (ARN) of the transform job.

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

    • creationTime

      public final Instant creationTime()

      A timestamp that shows when the transform Job was created.

      Returns:
      A timestamp that shows when the transform Job was created.

    • transformEndTime

      public final Instant transformEndTime()

      Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

      Returns:
      Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      Indicates when the transform job was last modified.

      Returns:
      Indicates when the transform job was last modified.

    • transformJobStatus

      public final TransformJobStatus transformJobStatus()

      The status of the transform job.

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

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

    • transformJobStatusAsString

      public final String transformJobStatusAsString()

      The status of the transform job.

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

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

    • failureReason

      public final String failureReason()

      If the transform job failed, the reason it failed.

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

    • toBuilder

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

    • builder

      public static TransformJobSummary.Builder builder()

    • serializableBuilderClass

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