Class GetActionRecommendationsRequest

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

  • Method Details

    • campaignArn

      public final String campaignArn()

      The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

      Returns:
      The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

    • userId

      public final String userId()

      The user ID of the user to provide action recommendations for.

      Returns:
      The user ID of the user to provide action recommendations for.

    • numResults

      public final Integer numResults()

      The number of results to return. The default is 5. The maximum is 100.

      Returns:
      The number of results to return. The default is 5. The maximum is 100.

    • 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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.

    • toBuilder

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

    • builder

      public static GetActionRecommendationsRequest.Builder builder()

    • serializableBuilderClass

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