Class SearchRecommendationsRequest

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

  • Method Details

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • keyName

      public final String keyName()

      A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

      Returns:
      A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

    • hasKeyValues

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

    • keyValues

      public final List<String> keyValues()

      A list of key values. Provide one value for each field of the search key.

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

      Returns:
      A list of key values. Provide one value for each field of the search key.

    • recommender

      public final Recommender recommender()

      The recommender used to generate the recommendations.

      Returns:
      The recommender used to generate the recommendations.

    • hasCandidateIds

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

    • candidateIds

      public final List<String> candidateIds()

      A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

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

      Returns:
      A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

    • hasContext

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

    • context

      public final Map<String,String> context()

      The contextual metadata used to provide dynamic runtime information to tailor recommendations.

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

      Returns:
      The contextual metadata used to provide dynamic runtime information to tailor recommendations.

    • diversity

      public final RecommendationDiversityConfig diversity()

      Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

      Returns:
      Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

    • metadata

      public final RecommendationMetadata metadata()

      Configuration for metadata to include in recommendation responses.

      Returns:
      Configuration for metadata to include in recommendation responses.

    • maxRecommendations

      public final Integer maxRecommendations()

      The maximum number of recommendations to return. The default value is 5.

      Returns:
      The maximum number of recommendations to return. The default value is 5.

    • toBuilder

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

    • builder

      public static SearchRecommendationsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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