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

Class PredictedItem

java.lang.Object

software.amazon.awssdk.services.personalizeruntime.model.PredictedItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PredictedItem.Builder,PredictedItem>

@Generated("software.amazon.awssdk:codegen")
public final class PredictedItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PredictedItem.Builder,PredictedItem>

An object that identifies an item.

The and APIs return a list of PredictedItems.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PredictedItem.Builder

Method Summary

Modifier and Type	Method	Description
static PredictedItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata()	For responses, this returns true if the service returned a value for the Metadata property.
String	itemId()	The recommended item ID.
Map<String,String>	metadata()	Metadata about the item from your Items dataset.
String	promotionName()	The name of the promotion that included the predicted item.
Double	score()	A numeric representation of the model's certainty that the item will be the next user selection.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictedItem.Builder>	serializableBuilderClass()
PredictedItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

itemId

public final String itemId()

The recommended item ID.

Returns:

The recommended item ID.

score

public final Double score()

A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

Returns:

A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

promotionName

public final String promotionName()

The name of the promotion that included the predicted item.

Returns:

The name of the promotion that included the predicted item.

hasMetadata

public final boolean hasMetadata()

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

metadata

public final Map<String,String> metadata()

Metadata about the item from your Items dataset.

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

Returns:

Metadata about the item from your Items dataset.

toBuilder

public PredictedItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictedItem.Builder,PredictedItem>

builder

public static PredictedItem.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo