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

Class AlgorithmSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.AlgorithmSummary

All Implemented Interfaces:

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

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

Provides summary information about an algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlgorithmSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	algorithmArn()	The Amazon Resource Name (ARN) of the algorithm.
String	algorithmDescription()	A brief description of the algorithm.
String	algorithmName()	The name of the algorithm that is described by the summary.
AlgorithmStatus	algorithmStatus()	The overall status of the algorithm.
String	algorithmStatusAsString()	The overall status of the algorithm.
static AlgorithmSummary.Builder	builder()
Instant	creationTime()	A timestamp that shows when the algorithm was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AlgorithmSummary.Builder>	serializableBuilderClass()
AlgorithmSummary.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

algorithmName

public final String algorithmName()

The name of the algorithm that is described by the summary.

Returns:

The name of the algorithm that is described by the summary.

algorithmArn

public final String algorithmArn()

The Amazon Resource Name (ARN) of the algorithm.

Returns:

The Amazon Resource Name (ARN) of the algorithm.

algorithmDescription

public final String algorithmDescription()

A brief description of the algorithm.

Returns:

A brief description of the algorithm.

creationTime

public final Instant creationTime()

A timestamp that shows when the algorithm was created.

Returns:

A timestamp that shows when the algorithm was created.

algorithmStatus

public final AlgorithmStatus algorithmStatus()

The overall status of the algorithm.

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

Returns:

The overall status of the algorithm.

See Also:

AlgorithmStatus

algorithmStatusAsString

public final String algorithmStatusAsString()

The overall status of the algorithm.

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

Returns:

The overall status of the algorithm.

See Also:

AlgorithmStatus

toBuilder

public AlgorithmSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlgorithmSummary.Builder,AlgorithmSummary>

builder

public static AlgorithmSummary.Builder builder()

serializableBuilderClass

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