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

Class CreateImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateImageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateImageRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateImageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateImageRequest.Builder	builder()
String	description()	The description of the image.
String	displayName()	The display name of the image.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	imageName()	The name of the image.
String	roleArn()	The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateImageRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to apply to the image.
CreateImageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

description

public final String description()

The description of the image.

Returns:

The description of the image.

displayName

public final String displayName()

The display name of the image. If not provided, ImageName is displayed.

Returns:

The display name of the image. If not provided, ImageName is displayed.

imageName

public final String imageName()

The name of the image. Must be unique to your account.

Returns:

The name of the image. Must be unique to your account.

roleArn

public final String roleArn()

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Returns:

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags to apply to the image.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to apply to the image.

toBuilder

public CreateImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateImageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateImageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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