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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TrainingPlanOffering.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TrainingPlanOffering.Builder`	`builder()`
`String`	`currencyCode()`	The currency code for the upfront fee (e.g., USD).
`Long`	`durationHours()`	The number of whole hours in the total duration for this training plan offering.
`Long`	`durationMinutes()`	The additional minutes beyond whole hours in the total duration for this training plan offering.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReservedCapacityOfferings()`	For responses, this returns true if the service returned a value for the ReservedCapacityOfferings property.
`boolean`	`hasTargetResources()`	For responses, this returns true if the service returned a value for the TargetResources property.
`Instant`	`requestedEndTimeBefore()`	The requested end time that the user specified when searching for the training plan offering.
`Instant`	`requestedStartTimeAfter()`	The requested start time that the user specified when searching for the training plan offering.
`List<ReservedCapacityOffering>`	`reservedCapacityOfferings()`	A list of reserved capacity offerings associated with this training plan offering.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TrainingPlanOffering.Builder>`	`serializableBuilderClass()`
`List<SageMakerResourceName>`	`targetResources()`	The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.
`List<String>`	`targetResourcesAsStrings()`	The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.
`TrainingPlanOffering.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`trainingPlanOfferingId()`	The unique identifier for this training plan offering.
`String`	`upfrontFee()`	The upfront fee for this training plan offering.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TrainingPlanOffering.Builder,TrainingPlanOffering>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TrainingPlanOffering

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

trainingPlanOfferingId

targetResources

hasTargetResources

targetResourcesAsStrings

requestedStartTimeAfter

requestedEndTimeBefore

durationHours

durationMinutes

upfrontFee

currencyCode

hasReservedCapacityOfferings

reservedCapacityOfferings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField