software.amazon.awssdk.services.sagemaker.model

Class AlgorithmStatusItem

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.AlgorithmStatusItem

All Implemented Interfaces:

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

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

Represents the overall status of an algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AlgorithmStatusItem.Builder

Method Summary

Modifier and Type	Method and Description
static AlgorithmStatusItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() if the overall status is Failed, the reason for the failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the algorithm for which the overall status is being reported.
List<SdkField<?>>	sdkFields()
static Class<? extends AlgorithmStatusItem.Builder>	serializableBuilderClass()
DetailedAlgorithmStatus	status() The current status.
String	statusAsString() The current status.
AlgorithmStatusItem.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

name

public final String name()

The name of the algorithm for which the overall status is being reported.

Returns:

The name of the algorithm for which the overall status is being reported.

status

public final DetailedAlgorithmStatus status()

The current status.

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

Returns:

The current status.

See Also:

DetailedAlgorithmStatus

statusAsString

public final String statusAsString()

The current status.

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

Returns:

The current status.

See Also:

DetailedAlgorithmStatus

failureReason

public final String failureReason()

if the overall status is Failed, the reason for the failure.

Returns:

if the overall status is Failed, the reason for the failure.

toBuilder

public AlgorithmStatusItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlgorithmStatusItem.Builder,AlgorithmStatusItem>

builder

public static AlgorithmStatusItem.Builder builder()

serializableBuilderClass

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