Class TrainingJobSummary

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

Provides summary information about a training job.

See Also:

  • Method Details

    • trainingJobName

      public final String trainingJobName()

      The name of the training job that you want a summary for.

      Returns:
      The name of the training job that you want a summary for.

    • trainingJobArn

      public final String trainingJobArn()

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

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

    • creationTime

      public final Instant creationTime()

      A timestamp that shows when the training job was created.

      Returns:
      A timestamp that shows when the training job was created.

    • trainingEndTime

      public final Instant trainingEndTime()

      A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

      Returns:
      A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

    • lastModifiedTime

      public final Instant lastModifiedTime()

      Timestamp when the training job was last modified.

      Returns:
      Timestamp when the training job was last modified.

    • trainingJobStatus

      public final TrainingJobStatus trainingJobStatus()

      The status of the training job.

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

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

    • trainingJobStatusAsString

      public final String trainingJobStatusAsString()

      The status of the training job.

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

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

    • secondaryStatus

      public final SecondaryStatus secondaryStatus()

      The secondary status of the training job.

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

      Returns:
      The secondary status of the training job.
      See Also:

    • secondaryStatusAsString

      public final String secondaryStatusAsString()

      The secondary status of the training job.

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

      Returns:
      The secondary status of the training job.
      See Also:

    • warmPoolStatus

      public final WarmPoolStatus warmPoolStatus()

      The status of the warm pool associated with the training job.

      Returns:
      The status of the warm pool associated with the training job.

    • trainingPlanArn

      public final String trainingPlanArn()

      The Amazon Resource Name (ARN); of the training plan associated with this training job.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

      Returns:
      The Amazon Resource Name (ARN); of the training plan associated with this training job.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

    • toBuilder

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

    • builder

      public static TrainingJobSummary.Builder builder()

    • serializableBuilderClass

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