@Generated(value="software.amazon.awssdk:codegen") public final class GetRecommendationsRequest extends PersonalizeRuntimeRequest implements ToCopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetRecommendationsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetRecommendationsRequest.Builder |
builder() |
String |
campaignArn()
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
|
Map<String,String> |
context()
The contextual metadata to use when getting recommendations.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
filterArn()
The ARN of the filter to apply to the returned recommendations.
|
Map<String,String> |
filterValues()
The values to use when filtering recommendations.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasContext()
For responses, this returns true if the service returned a value for the Context property.
|
boolean |
hasFilterValues()
For responses, this returns true if the service returned a value for the FilterValues property.
|
int |
hashCode() |
String |
itemId()
The item ID to provide recommendations for.
|
Integer |
numResults()
The number of results to return.
|
String |
recommenderArn()
The Amazon Resource Name (ARN) of the recommender to use to get recommendations.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetRecommendationsRequest.Builder> |
serializableBuilderClass() |
GetRecommendationsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
userId()
The user ID to provide recommendations for.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String campaignArn()
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
public final String itemId()
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
Required for RELATED_ITEMS recipe type.
public final String userId()
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
Required for USER_PERSONALIZATION recipe type.
public final Integer numResults()
The number of results to return. The default is 25. The maximum is 500.
public final boolean hasContext()
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.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.
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.
When using this parameter, be sure the filter resource is ACTIVE.
public final boolean hasFilterValues()
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.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.
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.
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.
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.
public GetRecommendationsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>toBuilder in class PersonalizeRuntimeRequestpublic static GetRecommendationsRequest.Builder builder()
public static Class<? extends GetRecommendationsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.