Class GetProfileRecommendationsRequest

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.GetProfileRecommendationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetProfileRecommendationsRequest.Builder,GetProfileRecommendationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetProfileRecommendationsRequest extends CustomerProfilesRequest implements ToCopyableBuilder<GetProfileRecommendationsRequest.Builder,GetProfileRecommendationsRequest>

  • Method Details

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • profileId

      public final String profileId()

      The unique identifier of the profile for which to retrieve recommendations.

      Returns:
      The unique identifier of the profile for which to retrieve recommendations.

    • recommenderName

      public final String recommenderName()

      The unique name of the recommender.

      Returns:
      The unique name of the recommender.

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

    • hasRecommenderFilters

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

    • recommenderFilters

      public final List<RecommenderFilter> recommenderFilters()

      A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

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

      Returns:
      A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

    • hasRecommenderPromotionalFilters

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

    • recommenderPromotionalFilters

      public final List<RecommenderPromotionalFilter> recommenderPromotionalFilters()

      A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

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

      Returns:
      A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

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

    • maxResults

      public final Integer maxResults()

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

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

    • metadataConfig

      public final MetadataConfig metadataConfig()

      Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

      Returns:
      Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

    • toBuilder

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

    • builder

      public static GetProfileRecommendationsRequest.Builder builder()

    • serializableBuilderClass

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