software.amazon.awssdk.services.personalize.model

Class Recommender

java.lang.Object

software.amazon.awssdk.services.personalize.model.Recommender

All Implemented Interfaces:

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

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

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Recommender.Builder

Method Summary

Modifier and Type	Method and Description
static Recommender.Builder	builder()
Instant	creationDateTime() The date and time (in Unix format) that the recommender was created.
String	datasetGroupArn() The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If a recommender fails, the reason behind the failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDateTime() The date and time (in Unix format) that the recommender was last updated.
RecommenderUpdateSummary	latestRecommenderUpdate() Provides a summary of the latest updates to the recommender.
String	name() The name of the recommender.
String	recipeArn() The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
String	recommenderArn() The Amazon Resource Name (ARN) of the recommender.
RecommenderConfig	recommenderConfig() The configuration details of the recommender.
List<SdkField<?>>	sdkFields()
static Class<? extends Recommender.Builder>	serializableBuilderClass()
String	status() The status of the recommender.
Recommender.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

recommenderArn

public final String recommenderArn()

The Amazon Resource Name (ARN) of the recommender.

Returns:

The Amazon Resource Name (ARN) of the recommender.

datasetGroupArn

public final String datasetGroupArn()

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Returns:

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

name

public final String name()

The name of the recommender.

Returns:

The name of the recommender.

recipeArn

public final String recipeArn()

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

Returns:

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

recommenderConfig

public final RecommenderConfig recommenderConfig()

The configuration details of the recommender.

Returns:

The configuration details of the recommender.

creationDateTime

public final Instant creationDateTime()

The date and time (in Unix format) that the recommender was created.

Returns:

The date and time (in Unix format) that the recommender was created.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The date and time (in Unix format) that the recommender was last updated.

Returns:

The date and time (in Unix format) that the recommender was last updated.

status

public final String status()

The status of the recommender.

A recommender can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

Returns:

The status of the recommender.

A recommender can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

failureReason

public final String failureReason()

If a recommender fails, the reason behind the failure.

Returns:

If a recommender fails, the reason behind the failure.

latestRecommenderUpdate

public final RecommenderUpdateSummary latestRecommenderUpdate()

Provides a summary of the latest updates to the recommender.

Returns:

Provides a summary of the latest updates to the recommender.

toBuilder

public Recommender.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Recommender.Builder,Recommender>

builder

public static Recommender.Builder builder()

serializableBuilderClass

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