Package software.amazon.awssdk.services.personalize.model

Class CreateSolutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.personalize.model.PersonalizeRequest
software.amazon.awssdk.services.personalize.model.CreateSolutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSolutionRequest.Builder,CreateSolutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSolutionRequest extends PersonalizeRequest implements ToCopyableBuilder<CreateSolutionRequest.Builder,CreateSolutionRequest>

  • Method Details

    • name

      public final String name()

      The name for the solution.

      Returns:
      The name for the solution.

    • performHPO

      public final Boolean performHPO()

      Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

      When performing AutoML, this parameter is always true and you should not set it to false.

      Returns:
      Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

      When performing AutoML, this parameter is always true and you should not set it to false.

    • performAutoML

      public final Boolean performAutoML()

      We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

      Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

      When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

      Returns:

      We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

      Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

      When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

    • recipeArn

      public final String recipeArn()

      The ARN of the recipe to use for model training. This is required when performAutoML is false.

      Returns:
      The ARN of the recipe to use for model training. This is required when performAutoML is false.

    • datasetGroupArn

      public final String datasetGroupArn()

      The Amazon Resource Name (ARN) of the dataset group that provides the training data.

      Returns:
      The Amazon Resource Name (ARN) of the dataset group that provides the training data.

    • eventType

      public final String eventType()

      When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

      If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

      Returns:
      When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

      If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

    • solutionConfig

      public final SolutionConfig solutionConfig()

      The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

      Amazon Personalize doesn't support configuring the hpoObjective at this time.

      Returns:
      The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

      Amazon Personalize doesn't support configuring the hpoObjective at this time.

    • 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 solution.

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

    • toBuilder

      public CreateSolutionRequest.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<CreateSolutionRequest.Builder,CreateSolutionRequest>
      Specified by:
      toBuilder in class PersonalizeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateSolutionRequest.Builder builder()

    • serializableBuilderClass

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