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

Interface TrainingPlanSummary.Builder

    • Method Detail

      • trainingPlanArn

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

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

        TrainingPlanSummary.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:
        TrainingPlanStatus, TrainingPlanStatus

      • status

        TrainingPlanSummary.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:
        TrainingPlanStatus, TrainingPlanStatus

      • statusMessage

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

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

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

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

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

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

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

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

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

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

        TrainingPlanSummary.Builder targetResourcesWithStrings​(Collection<String> targetResources)

        The target resources (e.g., training jobs, HyperPod clusters) 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., training jobs, HyperPod clusters) 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

        TrainingPlanSummary.Builder targetResourcesWithStrings​(String... targetResources)

        The target resources (e.g., training jobs, HyperPod clusters) 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., training jobs, HyperPod clusters) 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

        TrainingPlanSummary.Builder targetResources​(Collection<SageMakerResourceName> targetResources)

        The target resources (e.g., training jobs, HyperPod clusters) 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., training jobs, HyperPod clusters) 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

        TrainingPlanSummary.Builder targetResources​(SageMakerResourceName... targetResources)

        The target resources (e.g., training jobs, HyperPod clusters) 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., training jobs, HyperPod clusters) 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

        TrainingPlanSummary.Builder reservedCapacitySummaries​(Collection<ReservedCapacitySummary> reservedCapacitySummaries)

        A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

        Parameters:
        reservedCapacitySummaries - A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reservedCapacitySummaries

        TrainingPlanSummary.Builder reservedCapacitySummaries​(ReservedCapacitySummary... reservedCapacitySummaries)

        A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

        Parameters:
        reservedCapacitySummaries - A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.