com.amazonaws.services.sagemaker.model

Class WarmPoolStatus

java.lang.Object

com.amazonaws.services.sagemaker.model.WarmPoolStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WarmPoolStatus
extends Object
implements Serializable, Cloneable, StructuredPojo

Status and billing information about the warm pool.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WarmPoolStatus()

Method Summary

Modifier and Type	Method and Description
WarmPoolStatus	clone()
boolean	equals(Object obj)
Integer	getResourceRetainedBillableTimeInSeconds() The billable time in seconds used by the warm pool.
String	getReusedByJob() The name of the matching training job that reused the warm pool.
String	getStatus() The status of the warm pool.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setResourceRetainedBillableTimeInSeconds(Integer resourceRetainedBillableTimeInSeconds) The billable time in seconds used by the warm pool.
void	setReusedByJob(String reusedByJob) The name of the matching training job that reused the warm pool.
void	setStatus(String status) The status of the warm pool.
String	toString() Returns a string representation of this object.
WarmPoolStatus	withResourceRetainedBillableTimeInSeconds(Integer resourceRetainedBillableTimeInSeconds) The billable time in seconds used by the warm pool.
WarmPoolStatus	withReusedByJob(String reusedByJob) The name of the matching training job that reused the warm pool.
WarmPoolStatus	withStatus(String status) The status of the warm pool.
WarmPoolStatus	withStatus(WarmPoolResourceStatus status) The status of the warm pool.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WarmPoolStatus

public WarmPoolStatus()

Method Detail

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

WarmPoolResourceStatus

getStatus

public String getStatus()

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.

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

withStatus

public WarmPoolStatus withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WarmPoolResourceStatus

withStatus

public WarmPoolStatus withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WarmPoolResourceStatus

setResourceRetainedBillableTimeInSeconds

public void setResourceRetainedBillableTimeInSeconds(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 .

Parameters:

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.

getResourceRetainedBillableTimeInSeconds

public Integer getResourceRetainedBillableTimeInSeconds()

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.

withResourceRetainedBillableTimeInSeconds

public WarmPoolStatus withResourceRetainedBillableTimeInSeconds(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 .

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setReusedByJob

public void setReusedByJob(String reusedByJob)

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

Parameters:

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

getReusedByJob

public String getReusedByJob()

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.

withReusedByJob

public WarmPoolStatus withReusedByJob(String reusedByJob)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public WarmPoolStatus clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.