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

Class WarmPoolStatus

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.WarmPoolStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WarmPoolStatus.Builder,WarmPoolStatus>

@Generated("software.amazon.awssdk:codegen")
public final class WarmPoolStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WarmPoolStatus.Builder,WarmPoolStatus>

Status and billing information about the warm pool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WarmPoolStatus.Builder

Method Summary

Modifier and Type	Method	Description
static WarmPoolStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	resourceRetainedBillableTimeInSeconds()	The billable time in seconds used by the warm pool.
String	reusedByJob()	The name of the matching training job that reused the warm pool.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WarmPoolStatus.Builder>	serializableBuilderClass()
WarmPoolResourceStatus	status()	The status of the warm pool.
String	statusAsString()	The status of the warm pool.
WarmPoolStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

status

public final WarmPoolResourceStatus status()

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

If the service returns an enum value that is not available in the current SDK version, status will return WarmPoolResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

See Also:

WarmPoolResourceStatus

statusAsString

public final String statusAsString()

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

If the service returns an enum value that is not available in the current SDK version, status will return WarmPoolResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

See Also:

WarmPoolResourceStatus

resourceRetainedBillableTimeInSeconds

public final Integer resourceRetainedBillableTimeInSeconds()

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances ( InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount .

Returns:

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances ( InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

reusedByJob

public final String reusedByJob()

The name of the matching training job that reused the warm pool.

Returns:

The name of the matching training job that reused the warm pool.

toBuilder

public WarmPoolStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WarmPoolStatus.Builder,WarmPoolStatus>

builder

public static WarmPoolStatus.Builder builder()

serializableBuilderClass

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