Class DiversityColumn

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

Defines a diversity constraint for a single item column, specifying a cap type and a target value or placeholder that controls how many recommended items may share the same column value.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the item catalog column on which to apply the diversity cap. The column must be defined in the recommender schema.

      Returns:
      The name of the item catalog column on which to apply the diversity cap. The column must be defined in the recommender schema.

    • capType

      public final DiversityCapType capType()

      The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count).

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

      Returns:
      The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count).
      See Also:

    • capTypeAsString

      public final String capTypeAsString()

      The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count).

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

      Returns:
      The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count).
      See Also:

    • target

      public final String target()

      The diversity cap target. Either an integer literal (for example, "25") or a placeholder expression of the form $name whose value is supplied at inference time through GetProfileRecommendations.

      Returns:
      The diversity cap target. Either an integer literal (for example, "25") or a placeholder expression of the form $name whose value is supplied at inference time through GetProfileRecommendations.

    • toBuilder

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

    • builder

      public static DiversityColumn.Builder builder()

    • serializableBuilderClass

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