Class RecommenderSchemaField

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

Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.

See Also:

  • Method Details

    • targetFieldName

      public final String targetFieldName()

      The name of the target field in the dataset, such as Location.City or Attributes.MealTime.

      Returns:
      The name of the target field in the dataset, such as Location.City or Attributes.MealTime.

    • contentType

      public final ContentType contentType()

      The data type of the column value. Valid values are String and Number. The default value is String.

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

      Returns:
      The data type of the column value. Valid values are String and Number. The default value is String.
      See Also:

    • contentTypeAsString

      public final String contentTypeAsString()

      The data type of the column value. Valid values are String and Number. The default value is String.

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

      Returns:
      The data type of the column value. Valid values are String and Number. The default value is String.
      See Also:

    • featureType

      public final FeatureType featureType()

      How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL.

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

      Returns:
      How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL.
      See Also:

    • featureTypeAsString

      public final String featureTypeAsString()

      How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL.

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

      Returns:
      How the column is treated for model training. Valid values are CATEGORICAL and TEXTUAL.
      See Also:

    • toBuilder

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

    • builder

      public static RecommenderSchemaField.Builder builder()

    • serializableBuilderClass

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