software.amazon.awssdk.services.sagemaker.model

Class CreateAutoMlJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAutoMlJobRequest.Builder,CreateAutoMlJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAutoMlJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
AutoMLJobConfig	autoMLJobConfig() Contains CompletionCriteria and SecurityConfig.
String	autoMLJobName() Identifies an AutoPilot job.
AutoMLJobObjective	autoMLJobObjective() Defines the job's objective.
static CreateAutoMlJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	generateCandidateDefinitionsOnly() This will generate possible candidates without training a model.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputDataConfig() Returns true if the InputDataConfig property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<AutoMLChannel>	inputDataConfig() Similar to InputDataConfig supported by Tuning.
AutoMLOutputDataConfig	outputDataConfig() Similar to OutputDataConfig supported by Tuning.
ProblemType	problemType() Defines the kind of preprocessing and algorithms intended for the candidates.
String	problemTypeAsString() Defines the kind of preprocessing and algorithms intended for the candidates.
String	roleArn() The ARN of the role that will be used to access the data.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAutoMlJobRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Each tag consists of a key and an optional value.
CreateAutoMlJobRequest.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 String autoMLJobName()

Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.

Returns:

Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.

hasInputDataConfig

public boolean hasInputDataConfig()

Returns true if the InputDataConfig property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

inputDataConfig

public List<AutoMLChannel> inputDataConfig()

Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 1000 rows.

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

You can use hasInputDataConfig() to see if a value was sent in this field.

Returns:

Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 1000 rows.

outputDataConfig

public AutoMLOutputDataConfig outputDataConfig()

Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.

Returns:

Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.

problemType

public ProblemType problemType()

Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.

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

Returns:

Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.

See Also:

ProblemType

problemTypeAsString

public String problemTypeAsString()

Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.

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

Returns:

Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.

See Also:

ProblemType

autoMLJobObjective

public AutoMLJobObjective autoMLJobObjective()

Defines the job's objective. You provide a MetricName and AutoML will infer minimize or maximize. If this is not provided, the most commonly used ObjectiveMetric for problem type will be selected.

Returns:

Defines the job's objective. You provide a MetricName and AutoML will infer minimize or maximize. If this is not provided, the most commonly used ObjectiveMetric for problem type will be selected.

autoMLJobConfig

public AutoMLJobConfig autoMLJobConfig()

Contains CompletionCriteria and SecurityConfig.

Returns:

Contains CompletionCriteria and SecurityConfig.

roleArn

public String roleArn()

The ARN of the role that will be used to access the data.

Returns:

The ARN of the role that will be used to access the data.

generateCandidateDefinitionsOnly

public Boolean generateCandidateDefinitionsOnly()

This will generate possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

Returns:

This will generate possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<Tag> tags()

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

toBuilder

public CreateAutoMlJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAutoMlJobRequest.Builder,CreateAutoMlJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateAutoMlJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo