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(value="software.amazon.awssdk:codegen")
public final class GetRecommendationsRequest
extends PersonalizeRuntimeRequest
implements ToCopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetRecommendationsRequest.Builder

Method Summary

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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContext() Returns true if the Context property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	itemId() The item ID to provide recommendations for.
Integer	numResults() The number of results to return.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

campaignArn

public 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 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 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 Integer numResults()

The number of results to return. The default is 25. The maximum is 500.

Returns:

The number of results to return. The default is 25. The maximum is 500.

hasContext

public boolean hasContext()

Returns true if the Context property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

context

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

You can use hasContext() to see if a value was sent in this field.

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 String filterArn()

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

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 Using Filters with Amazon Personalize.

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

toBuilder

public GetRecommendationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>

Specified by:

toBuilder in class PersonalizeRuntimeRequest

builder

public static GetRecommendationsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetRecommendationsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo