Package software.amazon.awssdk.services.personalizeruntime.model

Class GetRecommendationsRequest

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

  • Method Details

    • campaignArn

      public final String campaignArn()

      The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

      Returns:
      The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

    • itemId

      public final String itemId()

      The item ID to provide recommendations for.

      Required for RELATED_ITEMS recipe type.

      Returns:
      The item ID to provide recommendations for.

      Required for RELATED_ITEMS recipe type.

    • userId

      public final String userId()

      The user ID to provide recommendations for.

      Required for USER_PERSONALIZATION recipe type.

      Returns:
      The user ID to provide recommendations for.

      Required for USER_PERSONALIZATION recipe type.

    • numResults

      public final Integer numResults()

      The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

      Returns:
      The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

    • 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 to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

      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 to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

    • filterArn

      public final String filterArn()

      The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

      When using this parameter, be sure the filter resource is ACTIVE.

      Returns:
      The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

      When using this parameter, be sure the filter resource is ACTIVE.

    • hasFilterValues

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

    • filterValues

      public final Map<String,String> filterValues()

      The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

      For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

      For more information, see Filtering recommendations and user segments.

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

      Returns:
      The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

      For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

      For more information, see Filtering recommendations and user segments.

    • recommenderArn

      public final String recommenderArn()

      The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

      Returns:
      The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

    • hasPromotions

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

    • promotions

      public final List<Promotion> promotions()

      The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

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

      Returns:
      The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

    • hasMetadataColumns

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

    • metadataColumns

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

      If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

      For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

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

      Returns:
      If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

      For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

    • toBuilder

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

    • builder

      public static GetRecommendationsRequest.Builder builder()

    • serializableBuilderClass

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