Class RecommenderConfig

java.lang.Object
software.amazon.awssdk.services.customerprofiles.model.RecommenderConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>
@Generated("software.amazon.awssdk:codegen") public final class RecommenderConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>

Configuration settings that define the behavior and parameters of a recommender.

See Also:

  • Method Details

    • eventsConfig

      public final EventsConfig eventsConfig()

      Configuration settings for how the recommender processes and uses events.

      Returns:
      Configuration settings for how the recommender processes and uses events.

    • trainingFrequency

      public final Integer trainingFrequency()

      How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.

      Returns:
      How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.

    • inferenceConfig

      public final InferenceConfig inferenceConfig()

      Configuration settings for how the recommender handles inference requests.

      Returns:
      Configuration settings for how the recommender handles inference requests.

    • hasIncludedColumns

      public final boolean hasIncludedColumns()
      For responses, this returns true if the service returned a value for the IncludedColumns 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.

    • includedColumns

      public final Map<String,List<String>> includedColumns()

      A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.

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

      Returns:
      A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.

    • hasExcludedColumns

      public final boolean hasExcludedColumns()
      For responses, this returns true if the service returned a value for the ExcludedColumns 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.

    • excludedColumns

      public final Map<String,List<String>> excludedColumns()

      A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.

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

      Returns:
      A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp , and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.

    • toBuilder

      public RecommenderConfig.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<RecommenderConfig.Builder,RecommenderConfig>
      Returns:
      a builder for type T

    • builder

      public static RecommenderConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.