software.amazon.awssdk.services.sagemaker.model

Class CreateAutoMlJobV2Request

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAutoMlJobV2Request.Builder,CreateAutoMlJobV2Request>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAutoMlJobV2Request.Builder

Method Summary

Modifier and Type	Method and Description
List<AutoMLJobChannel>	autoMLJobInputDataConfig() An array of channel objects describing the input data and their location.
String	autoMLJobName() Identifies an Autopilot job.
AutoMLJobObjective	autoMLJobObjective() Specifies a metric to minimize or maximize as the objective of a job.
AutoMLProblemTypeConfig	autoMLProblemTypeConfig() Defines the configuration settings of one of the supported problem types.
static CreateAutoMlJobV2Request.Builder	builder()
AutoMLDataSplitConfig	dataSplitConfig() This structure specifies how to split the data into train and validation datasets.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAutoMLJobInputDataConfig() For responses, this returns true if the service returned a value for the AutoMLJobInputDataConfig property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
ModelDeployConfig	modelDeployConfig() Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
AutoMLOutputDataConfig	outputDataConfig() Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
String	roleArn() The ARN of the role that is used to access the data.
List<SdkField<?>>	sdkFields()
AutoMLSecurityConfig	securityConfig() The security configuration for traffic encryption or Amazon VPC settings.
static Class<? extends CreateAutoMlJobV2Request.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateAutoMlJobV2Request.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

autoMLJobName

public final String autoMLJobName()

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

Returns:

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

hasAutoMLJobInputDataConfig

public final boolean hasAutoMLJobInputDataConfig()

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

autoMLJobInputDataConfig

public final List<AutoMLJobChannel> autoMLJobInputDataConfig()

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported formats depend on the problem type:

• ImageClassification: S3Prefix, ManifestFile, AugmentedManifestFile

• TextClassification: S3Prefix

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

Returns:

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported formats depend on the problem type:

• ImageClassification: S3Prefix, ManifestFile, AugmentedManifestFile

• TextClassification: S3Prefix

outputDataConfig

public final AutoMLOutputDataConfig outputDataConfig()

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

Returns:

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

autoMLProblemTypeConfig

public final AutoMLProblemTypeConfig autoMLProblemTypeConfig()

Defines the configuration settings of one of the supported problem types.

Returns:

Defines the configuration settings of one of the supported problem types.

roleArn

public final String roleArn()

The ARN of the role that is used to access the data.

Returns:

The ARN of the role that is used to access the data.

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()

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

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:

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

securityConfig

public final AutoMLSecurityConfig securityConfig()

The security configuration for traffic encryption or Amazon VPC settings.

Returns:

The security configuration for traffic encryption or Amazon VPC settings.

autoMLJobObjective

public final AutoMLJobObjective autoMLJobObjective()

Specifies a metric to minimize or maximize as the objective of a job. For CreateAutoMLJobV2, only Accuracy is supported.

Returns:

Specifies a metric to minimize or maximize as the objective of a job. For CreateAutoMLJobV2, only Accuracy is supported.

modelDeployConfig

public final ModelDeployConfig modelDeployConfig()

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

Returns:

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

dataSplitConfig

public final AutoMLDataSplitConfig dataSplitConfig()

This structure specifies how to split the data into train and validation datasets.

If you are using the V1 API (for example CreateAutoMLJob) or the V2 API for Natural Language Processing problems (for example CreateAutoMLJobV2 with a TextClassificationJobConfig problem type), the validation and training datasets must contain the same headers. Also, for V1 API jobs, the validation dataset must be less than 2 GB in size.

Returns:

This structure specifies how to split the data into train and validation datasets.

If you are using the V1 API (for example CreateAutoMLJob) or the V2 API for Natural Language Processing problems (for example CreateAutoMLJobV2 with a TextClassificationJobConfig problem type), the validation and training datasets must contain the same headers. Also, for V1 API jobs, the validation dataset must be less than 2 GB in size.

toBuilder

public CreateAutoMlJobV2Request.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAutoMlJobV2Request.Builder,CreateAutoMlJobV2Request>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateAutoMlJobV2Request.Builder builder()

serializableBuilderClass

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