software.amazon.awssdk.services.personalizeruntime.model

Class GetPersonalizedRankingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetPersonalizedRankingRequest
extends PersonalizeRuntimeRequest
implements ToCopyableBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetPersonalizedRankingRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetPersonalizedRankingRequest.Builder	builder()
String	campaignArn() The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
Map<String,String>	context() The contextual metadata to use when getting recommendations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterArn() The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.
<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()
boolean	hasInputList() Returns true if the InputList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	inputList() A list of items (by itemId) to rank.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPersonalizedRankingRequest.Builder>	serializableBuilderClass()
GetPersonalizedRankingRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The user for which you want the campaign to provide a personalized ranking.

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 generating the personalized ranking.

Returns:

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

hasInputList

public boolean hasInputList()

Returns true if the InputList 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.

inputList

public List<String> inputList()

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

userId

public String userId()

The user for which you want the campaign to provide a personalized ranking.

Returns:

The user for which you want the campaign to provide a personalized ranking.

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 Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Returns:

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

toBuilder

public GetPersonalizedRankingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>

Specified by:

toBuilder in class PersonalizeRuntimeRequest

builder

public static GetPersonalizedRankingRequest.Builder builder()

serializableBuilderClass

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