software.amazon.awssdk.services.sagemaker.model

Class CreateArtifactRequest

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.CreateArtifactRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateArtifactRequest.Builder,CreateArtifactRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateArtifactRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	artifactName() The name of the artifact.
String	artifactType() The artifact type.
static CreateArtifactRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties() For responses, this returns true if the service returned a value for the Properties property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
MetadataProperties	metadataProperties() Returns the value of the MetadataProperties property for this object.
Map<String,String>	properties() A list of properties to add to the artifact.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateArtifactRequest.Builder>	serializableBuilderClass()
ArtifactSource	source() The ID, ID type, and URI of the source.
List<Tag>	tags() A list of tags to apply to the artifact.
CreateArtifactRequest.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

artifactName

public final String artifactName()

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

Returns:

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

source

public final ArtifactSource source()

The ID, ID type, and URI of the source.

Returns:

The ID, ID type, and URI of the source.

artifactType

public final String artifactType()

The artifact type.

Returns:

The artifact type.

hasProperties

public final boolean hasProperties()

For responses, this returns true if the service returned a value for the Properties 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.

properties

public final Map<String,String> properties()

A list of properties to add to the artifact.

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 hasProperties() method.

Returns:

A list of properties to add to the artifact.

metadataProperties

public final MetadataProperties metadataProperties()

Returns the value of the MetadataProperties property for this object.

Returns:

The value of the MetadataProperties property for this object.

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 artifact.

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 artifact.

toBuilder

public CreateArtifactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateArtifactRequest.Builder,CreateArtifactRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateArtifactRequest.Builder builder()

serializableBuilderClass

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