Class TrainingPlanOffering

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

Details about a training plan offering.

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

See Also:

  • Method Details

    • trainingPlanOfferingId

      public final String trainingPlanOfferingId()

      The unique identifier for this training plan offering.

      Returns:
      The unique identifier for this training plan offering.

    • targetResources

      public final List<SageMakerResourceName> targetResources()

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetResources() method.

      Returns:
      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.

      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.

    • hasTargetResources

      public final boolean hasTargetResources()
      For responses, this returns true if the service returned a value for the TargetResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • targetResourcesAsStrings

      public final List<String> targetResourcesAsStrings()

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetResources() method.

      Returns:
      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.

      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.

    • requestedStartTimeAfter

      public final Instant requestedStartTimeAfter()

      The requested start time that the user specified when searching for the training plan offering.

      Returns:
      The requested start time that the user specified when searching for the training plan offering.

    • requestedEndTimeBefore

      public final Instant requestedEndTimeBefore()

      The requested end time that the user specified when searching for the training plan offering.

      Returns:
      The requested end time that the user specified when searching for the training plan offering.

    • durationHours

      public final Long durationHours()

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

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

    • durationMinutes

      public final Long durationMinutes()

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

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

    • upfrontFee

      public final String upfrontFee()

      The upfront fee for this training plan offering.

      Returns:
      The upfront fee for this training plan offering.

    • currencyCode

      public final String currencyCode()

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

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

    • hasReservedCapacityOfferings

      public final boolean hasReservedCapacityOfferings()
      For responses, this returns true if the service returned a value for the ReservedCapacityOfferings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • reservedCapacityOfferings

      public final List<ReservedCapacityOffering> reservedCapacityOfferings()

      A list of reserved capacity offerings associated with this training plan offering.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReservedCapacityOfferings() method.

      Returns:
      A list of reserved capacity offerings associated with this training plan offering.

    • toBuilder

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

    • builder

      public static TrainingPlanOffering.Builder builder()

    • serializableBuilderClass

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