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

Class TrainingJobSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TrainingJobSummary

All Implemented Interfaces:

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

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

Provides summary information about a training job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TrainingJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
static TrainingJobSummary.Builder	builder()
Instant	creationTime()	A timestamp that shows when the training job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime()	Timestamp when the training job was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends TrainingJobSummary.Builder>	serializableBuilderClass()
TrainingJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	trainingEndTime()	A timestamp that shows when the training job ended.
String	trainingJobArn()	The Amazon Resource Name (ARN) of the training job.
String	trainingJobName()	The name of the training job that you want a summary for.
TrainingJobStatus	trainingJobStatus()	The status of the training job.
String	trainingJobStatusAsString()	The status of the training job.
WarmPoolStatus	warmPoolStatus()	The status of the warm pool associated with the training job.

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

trainingJobName

public final String trainingJobName()

The name of the training job that you want a summary for.

Returns:

The name of the training job that you want a summary for.

trainingJobArn

public final String trainingJobArn()

The Amazon Resource Name (ARN) of the training job.

Returns:

The Amazon Resource Name (ARN) of the training job.

creationTime

public final Instant creationTime()

A timestamp that shows when the training job was created.

Returns:

A timestamp that shows when the training job was created.

trainingEndTime

public final Instant trainingEndTime()

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

Returns:

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

lastModifiedTime

public final Instant lastModifiedTime()

Timestamp when the training job was last modified.

Returns:

Timestamp when the training job was last modified.

trainingJobStatus

public final TrainingJobStatus trainingJobStatus()

The status of the training job.

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

Returns:

The status of the training job.

See Also:

TrainingJobStatus

trainingJobStatusAsString

public final String trainingJobStatusAsString()

The status of the training job.

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

Returns:

The status of the training job.

See Also:

TrainingJobStatus

warmPoolStatus

public final WarmPoolStatus warmPoolStatus()

The status of the warm pool associated with the training job.

Returns:

The status of the warm pool associated with the training job.

toBuilder

public TrainingJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TrainingJobSummary.Builder,TrainingJobSummary>

builder

public static TrainingJobSummary.Builder builder()

serializableBuilderClass

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