java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.TrainingPlanSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>
```
@Generated("software.amazon.awssdk:codegen")
public final class TrainingPlanSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>
```
Details of the training plan.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`availableInstanceCount()`	The number of instances currently available for use in this training plan.
`static TrainingPlanSummary.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.
`Long`	`durationMinutes()`	The additional minutes beyond whole hours in the total duration for this training plan.
`Instant`	`endTime()`	The end time of the training plan.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReservedCapacitySummaries()`	For responses, this returns true if the service returned a value for the ReservedCapacitySummaries property.
`boolean`	`hasTargetResources()`	For responses, this returns true if the service returned a value for the TargetResources property.
`Integer`	`inUseInstanceCount()`	The number of instances currently in use from this training plan.
`List<ReservedCapacitySummary>`	`reservedCapacitySummaries()`	A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TrainingPlanSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The start time of the training plan.
`TrainingPlanStatus`	`status()`	The current status of the training plan (e.g., Pending, Active, Expired).
`String`	`statusAsString()`	The current status of the training plan (e.g., Pending, Active, Expired).
`String`	`statusMessage()`	A message providing additional information about the current status of the training plan.
`List<SageMakerResourceName>`	`targetResources()`	The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
`List<String>`	`targetResourcesAsStrings()`	The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
`TrainingPlanSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`totalInstanceCount()`	The total number of instances reserved in this training plan.
`String`	`trainingPlanArn()`	The Amazon Resource Name (ARN); of the training plan.
`String`	`trainingPlanName()`	The name of the training plan.
`String`	`upfrontFee()`	The upfront fee for the training plan.

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
  - trainingPlanArn
```
public final String trainingPlanArn()
```
    The Amazon Resource Name (ARN); of the training plan.
    
    Returns:
    
    The Amazon Resource Name (ARN); of the training plan.
  - trainingPlanName
```
public final String trainingPlanName()
```
    The name of the training plan.
    
    Returns:
    
    The name of the training plan.
  - status
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TrainingPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    TrainingPlanStatus
  - statusAsString
```
public final String statusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TrainingPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    TrainingPlanStatus
  - statusMessage
```
public final String statusMessage()
```
    A message providing additional information about the current status of the training plan.
    
    Returns:
    
    A message providing additional information about the current status of the training plan.
  - durationHours
```
public final Long durationHours()
```
    The number of whole hours in the total duration for this training plan.
    
    Returns:
    
    The number of whole hours in the total duration for this training plan.
  - durationMinutes
```
public final Long durationMinutes()
```
    The additional minutes beyond whole hours in the total duration for this training plan.
    
    Returns:
    
    The additional minutes beyond whole hours in the total duration for this training plan.
  - startTime
```
public final Instant startTime()
```
    The start time of the training plan.
    
    Returns:
    
    The start time of the training plan.
  - endTime
```
public final Instant endTime()
```
    The end time of the training plan.
    
    Returns:
    
    The end time of the training plan.
  - upfrontFee
```
public final String upfrontFee()
```
    The upfront fee for the training plan.
    
    Returns:
    
    The upfront fee for the training plan.
  - 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).
  - totalInstanceCount
```
public final Integer totalInstanceCount()
```
    The total number of instances reserved in this training plan.
    
    Returns:
    
    The total number of instances reserved in this training plan.
  - availableInstanceCount
```
public final Integer availableInstanceCount()
```
    The number of instances currently available for use in this training plan.
    
    Returns:
    
    The number of instances currently available for use in this training plan.
  - inUseInstanceCount
```
public final Integer inUseInstanceCount()
```
    The number of instances currently in use from this training plan.
    
    Returns:
    
    The number of instances currently in use from this training plan.
  - targetResources
```
public final List<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.
    
    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., 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.
  - 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., 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.
    
    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., 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.
  - hasReservedCapacitySummaries
```
public final boolean hasReservedCapacitySummaries()
```
    For responses, this returns true if the service returned a value for the ReservedCapacitySummaries 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.
  - reservedCapacitySummaries
```
public final List<ReservedCapacitySummary> reservedCapacitySummaries()
```
    A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
    
    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 hasReservedCapacitySummaries() method.
    
    Returns:
    
    A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
  - toBuilder
```
public TrainingPlanSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>
  - builder
```
public static TrainingPlanSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TrainingPlanSummary.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 TrainingPlanSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

trainingPlanArn

trainingPlanName

status

statusAsString

statusMessage

durationHours

durationMinutes

startTime

endTime

upfrontFee

currencyCode

totalInstanceCount

availableInstanceCount

inUseInstanceCount

targetResources

hasTargetResources

targetResourcesAsStrings

hasReservedCapacitySummaries

reservedCapacitySummaries

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField