Package 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("software.amazon.awssdk:codegen") public final class CreateAutoMlJobRequest extends SageMakerRequest implements ToCopyableBuilder<CreateAutoMlJobRequest.Builder,CreateAutoMlJobRequest>

  • Method Details

    • 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 HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

      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 HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

    • 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 problem available for the candidates. For more information, see SageMaker Autopilot problem types.

      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 problem available for the candidates. For more information, see SageMaker Autopilot problem types.
      See Also:

    • problemTypeAsString

      public final String problemTypeAsString()

      Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.

      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 problem available for the candidates. For more information, see SageMaker Autopilot problem types.
      See Also:

    • autoMLJobObjective

      public final AutoMLJobObjective autoMLJobObjective()

      Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

      Returns:
      Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

    • autoMLJobConfig

      public final AutoMLJobConfig autoMLJobConfig()

      A collection of settings used to configure an AutoML job.

      Returns:
      A collection of settings used to configure an 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()

      An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, 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, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAutoMlJobRequest.Builder,CreateAutoMlJobRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.