Interface TrainingJobSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TrainingJobSummary.Builder,TrainingJobSummary>, SdkBuilder<TrainingJobSummary.Builder,TrainingJobSummary>, SdkPojo
Enclosing class:
TrainingJobSummary
@Mutable @NotThreadSafe public static interface TrainingJobSummary.Builder extends SdkPojo, CopyableBuilder<TrainingJobSummary.Builder,TrainingJobSummary>

  • Method Details

    • trainingJobName

      TrainingJobSummary.Builder trainingJobName(String trainingJobName)

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

      Parameters:
      trainingJobName - The name of the training job that you want a summary for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingJobArn

      TrainingJobSummary.Builder trainingJobArn(String trainingJobArn)

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

      Parameters:
      trainingJobArn - The Amazon Resource Name (ARN) of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      TrainingJobSummary.Builder creationTime(Instant creationTime)

      A timestamp that shows when the training job was created.

      Parameters:
      creationTime - A timestamp that shows when the training job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingEndTime

      TrainingJobSummary.Builder trainingEndTime(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      TrainingJobSummary.Builder lastModifiedTime(Instant lastModifiedTime)

      Timestamp when the training job was last modified.

      Parameters:
      lastModifiedTime - Timestamp when the training job was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingJobStatus

      TrainingJobSummary.Builder trainingJobStatus(String trainingJobStatus)

      The status of the training job.

      Parameters:
      trainingJobStatus - The status of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingJobStatus

      TrainingJobSummary.Builder trainingJobStatus(TrainingJobStatus trainingJobStatus)

      The status of the training job.

      Parameters:
      trainingJobStatus - The status of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryStatus

      TrainingJobSummary.Builder secondaryStatus(String secondaryStatus)

      The secondary status of the training job.

      Parameters:
      secondaryStatus - The secondary status of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryStatus

      TrainingJobSummary.Builder secondaryStatus(SecondaryStatus secondaryStatus)

      The secondary status of the training job.

      Parameters:
      secondaryStatus - The secondary status of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • warmPoolStatus

      TrainingJobSummary.Builder warmPoolStatus(WarmPoolStatus warmPoolStatus)

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

      Parameters:
      warmPoolStatus - The status of the warm pool associated with the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • warmPoolStatus

      default TrainingJobSummary.Builder warmPoolStatus(Consumer<WarmPoolStatus.Builder> warmPoolStatus)

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

      This is a convenience method that creates an instance of the WarmPoolStatus.Builder avoiding the need to create one manually via WarmPoolStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warmPoolStatus(WarmPoolStatus).

      Parameters:
      warmPoolStatus - a consumer that will call methods on WarmPoolStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingPlanArn

      TrainingJobSummary.Builder trainingPlanArn(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 .

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.