software.amazon.awssdk.services.personalize.model

Class RecommenderSummary

java.lang.Object

software.amazon.awssdk.services.personalize.model.RecommenderSummary

All Implemented Interfaces:

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

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

Provides a summary of the properties of the recommender.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommenderSummary.Builder

Method Summary

Modifier and Type	Method and Description
static RecommenderSummary.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)
<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.
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 RecommenderSummary.Builder>	serializableBuilderClass()
String	status() The status of the recommender.
RecommenderSummary.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

name

public final String name()

The name of the recommender.

Returns:

The name of the recommender.

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.

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.

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

• STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

• 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

• STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

• DELETE PENDING > DELETE IN_PROGRESS

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.

toBuilder

public RecommenderSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecommenderSummary.Builder,RecommenderSummary>

builder

public static RecommenderSummary.Builder builder()

serializableBuilderClass

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