CreateAutoMlJobRequest (AWS Java SDK :: Services :: Amazon SageMaker 2.17.36 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAutoMlJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoMLJobConfig`	`autoMLJobConfig()` Contains `CompletionCriteria` and `SecurityConfig` settings for the AutoML job.
`String`	`autoMLJobName()` Identifies an Autopilot job.
`AutoMLJobObjective`	`autoMLJobObjective()` Defines the objective metric used to measure the predictive quality of an AutoML job.
`static CreateAutoMlJobRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`generateCandidateDefinitionsOnly()` Generates possible candidates without training the models.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInputDataConfig()` For responses, this returns true if the service returned a value for the InputDataConfig property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<AutoMLChannel>`	`inputDataConfig()` An array of channel objects that describes the input data and its location.
`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.
`ProblemType`	`problemType()` Defines the type of supervised learning available for the candidates.
`String`	`problemTypeAsString()` Defines the type of supervised learning available for the candidates.
`String`	`roleArn()` The ARN of the role that is 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 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.
  - hasInputDataConfig
```
public final boolean hasInputDataConfig()
```
    For responses, this returns true if the service returned a value for the InputDataConfig 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.
  - inputDataConfig
```
public final List<AutoMLChannel> inputDataConfig()
```
    An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV. Minimum of 500 rows.
    
    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 hasInputDataConfig() method.
    
    Returns:
    
    An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV. Minimum of 500 rows.
  - outputDataConfig
```
public final AutoMLOutputDataConfig outputDataConfig()
```
    Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
    
    Returns:
    
    Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
  - problemType
```
public final ProblemType problemType()
```
    Defines the type of supervised learning available for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.
    
    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 type of supervised learning available for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.
    
    See Also:
    
    ProblemType
  - problemTypeAsString
```
public final String problemTypeAsString()
```
    Defines the type of supervised learning available for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.
    
    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 type of supervised learning available for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.
    
    See Also:
    
    ProblemType
  - autoMLJobObjective
```
public final AutoMLJobObjective autoMLJobObjective()
```
    Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it.
    
    Returns:
    
    Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it.
  - autoMLJobConfig
```
public final AutoMLJobConfig autoMLJobConfig()
```
    Contains CompletionCriteria and SecurityConfig settings for the AutoML job.
    
    Returns:
    
    Contains CompletionCriteria and SecurityConfig settings for the AutoML job.
  - 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.
  - generateCandidateDefinitionsOnly
```
public final Boolean generateCandidateDefinitionsOnly()
```
    Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
    
    Returns:
    
    Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
  - 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()
```
    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.
    
    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:
    
    Each tag consists of a key and an optional value. Tag keys must be unique per resource.
  - 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.
  - 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 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

Class CreateAutoMlJobRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

autoMLJobName

hasInputDataConfig

inputDataConfig

outputDataConfig

problemType

problemTypeAsString

autoMLJobObjective

autoMLJobConfig

roleArn

generateCandidateDefinitionsOnly

hasTags

tags

modelDeployConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields