Interface DescribeTrainingPlanResponse.Builder

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

  • Method Details

    • trainingPlanArn

      DescribeTrainingPlanResponse.Builder trainingPlanArn(String trainingPlanArn)

      The Amazon Resource Name (ARN); of the training plan.

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

    • trainingPlanName

      DescribeTrainingPlanResponse.Builder trainingPlanName(String trainingPlanName)

      The name of the training plan.

      Parameters:
      trainingPlanName - The name of the training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeTrainingPlanResponse.Builder status(String status)

      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

      Parameters:
      status - The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeTrainingPlanResponse.Builder status(TrainingPlanStatus status)

      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

      Parameters:
      status - The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      DescribeTrainingPlanResponse.Builder statusMessage(String statusMessage)

      A message providing additional information about the current status of the training plan.

      Parameters:
      statusMessage - A message providing additional information about the current status of the training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • durationHours

      DescribeTrainingPlanResponse.Builder durationHours(Long durationHours)

      The number of whole hours in the total duration for this training plan.

      Parameters:
      durationHours - The number of whole hours in the total duration for this training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • durationMinutes

      DescribeTrainingPlanResponse.Builder durationMinutes(Long durationMinutes)

      The additional minutes beyond whole hours in the total duration for this training plan.

      Parameters:
      durationMinutes - The additional minutes beyond whole hours in the total duration for this training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DescribeTrainingPlanResponse.Builder startTime(Instant startTime)

      The start time of the training plan.

      Parameters:
      startTime - The start time of the training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DescribeTrainingPlanResponse.Builder endTime(Instant endTime)

      The end time of the training plan.

      Parameters:
      endTime - The end time of the training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upfrontFee

      DescribeTrainingPlanResponse.Builder upfrontFee(String upfrontFee)

      The upfront fee for the training plan.

      Parameters:
      upfrontFee - The upfront fee for the training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currencyCode

      DescribeTrainingPlanResponse.Builder currencyCode(String currencyCode)

      The currency code for the upfront fee (e.g., USD).

      Parameters:
      currencyCode - The currency code for the upfront fee (e.g., USD).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalInstanceCount

      DescribeTrainingPlanResponse.Builder totalInstanceCount(Integer totalInstanceCount)

      The total number of instances reserved in this training plan.

      Parameters:
      totalInstanceCount - The total number of instances reserved in this training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availableInstanceCount

      DescribeTrainingPlanResponse.Builder availableInstanceCount(Integer availableInstanceCount)

      The number of instances currently available for use in this training plan.

      Parameters:
      availableInstanceCount - The number of instances currently available for use in this training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inUseInstanceCount

      DescribeTrainingPlanResponse.Builder inUseInstanceCount(Integer inUseInstanceCount)

      The number of instances currently in use from this training plan.

      Parameters:
      inUseInstanceCount - The number of instances currently in use from this training plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetResourcesWithStrings

      DescribeTrainingPlanResponse.Builder targetResourcesWithStrings(Collection<String> targetResources)

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Parameters:
      targetResources - The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetResourcesWithStrings

      DescribeTrainingPlanResponse.Builder targetResourcesWithStrings(String... targetResources)

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Parameters:
      targetResources - The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetResources

      DescribeTrainingPlanResponse.Builder targetResources(Collection<SageMakerResourceName> targetResources)

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Parameters:
      targetResources - The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetResources

      DescribeTrainingPlanResponse.Builder targetResources(SageMakerResourceName... targetResources)

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Parameters:
      targetResources - The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedCapacitySummaries

      DescribeTrainingPlanResponse.Builder reservedCapacitySummaries(Collection<ReservedCapacitySummary> reservedCapacitySummaries)

      The list of Reserved Capacity providing the underlying compute resources of the plan.

      Parameters:
      reservedCapacitySummaries - The list of Reserved Capacity providing the underlying compute resources of the plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedCapacitySummaries

      DescribeTrainingPlanResponse.Builder reservedCapacitySummaries(ReservedCapacitySummary... reservedCapacitySummaries)

      The list of Reserved Capacity providing the underlying compute resources of the plan.

      Parameters:
      reservedCapacitySummaries - The list of Reserved Capacity providing the underlying compute resources of the plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedCapacitySummaries

      DescribeTrainingPlanResponse.Builder reservedCapacitySummaries(Consumer<ReservedCapacitySummary.Builder>... reservedCapacitySummaries)

      The list of Reserved Capacity providing the underlying compute resources of the plan.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reservedCapacitySummaries(List<ReservedCapacitySummary>).

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