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

Class GetRecommendationsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.personalizeruntime.model.PersonalizeRuntimeResponse

software.amazon.awssdk.services.personalizeruntime.model.GetRecommendationsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRecommendationsResponse.Builder,GetRecommendationsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetRecommendationsResponse
extends PersonalizeRuntimeResponse
implements ToCopyableBuilder<GetRecommendationsResponse.Builder,GetRecommendationsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRecommendationsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetRecommendationsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItemList()	For responses, this returns true if the service returned a value for the ItemList property.
List<PredictedItem>	itemList()	A list of recommendations sorted in descending order by prediction score.
String	recommendationId()	The ID of the recommendation.
List<SdkField<?>>	sdkFields()
static Class<? extends GetRecommendationsResponse.Builder>	serializableBuilderClass()
GetRecommendationsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.personalizeruntime.model.PersonalizeRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasItemList

public final boolean hasItemList()

For responses, this returns true if the service returned a value for the ItemList 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.

itemList

public final List<PredictedItem> itemList()

A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

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

Returns:

A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

recommendationId

public final String recommendationId()

The ID of the recommendation.

Returns:

The ID of the recommendation.

toBuilder

public GetRecommendationsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecommendationsResponse.Builder,GetRecommendationsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetRecommendationsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo