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

Class Image

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Image

All Implemented Interfaces:

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

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

A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ImageVersion.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Image.Builder

Method Summary

Modifier and Type	Method	Description
static Image.Builder	builder()
Instant	creationTime()	When the image was created.
String	description()	The description of the image.
String	displayName()	The name of the image as displayed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	When a create, update, or delete operation fails, the reason for the failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageArn()	The ARN of the image.
String	imageName()	The name of the image.
ImageStatus	imageStatus()	The status of the image.
String	imageStatusAsString()	The status of the image.
Instant	lastModifiedTime()	When the image was last modified.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Image.Builder>	serializableBuilderClass()
Image.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

creationTime

public final Instant creationTime()

When the image was created.

Returns:

When the image was created.

description

public final String description()

The description of the image.

Returns:

The description of the image.

displayName

public final String displayName()

The name of the image as displayed.

Returns:

The name of the image as displayed.

failureReason

public final String failureReason()

When a create, update, or delete operation fails, the reason for the failure.

Returns:

When a create, update, or delete operation fails, the reason for the failure.

imageArn

public final String imageArn()

The ARN of the image.

Returns:

The ARN of the image.

imageName

public final String imageName()

The name of the image.

Returns:

The name of the image.

imageStatus

public final ImageStatus imageStatus()

The status of the image.

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

Returns:

The status of the image.

See Also:

ImageStatus

imageStatusAsString

public final String imageStatusAsString()

The status of the image.

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

Returns:

The status of the image.

See Also:

ImageStatus

lastModifiedTime

public final Instant lastModifiedTime()

When the image was last modified.

Returns:

When the image was last modified.

toBuilder

public Image.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Image.Builder,Image>

builder

public static Image.Builder builder()

serializableBuilderClass

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