Recommender (AWS Java SDK :: Services :: Personalize 2.18.35 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Recommender.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`boolean`	`hasModelMetrics()` For responses, this returns true if the service returned a value for the ModelMetrics property.
`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.
`Map<String,Double>`	`modelMetrics()` Provides evaluation metrics that help you determine the performance of a 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
    - 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
  - 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.
  - hasModelMetrics
```
public final boolean hasModelMetrics()
```
    For responses, this returns true if the service returned a value for the ModelMetrics 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.
  - modelMetrics
```
public final Map<String,Double> modelMetrics()
```
    Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
    
    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 hasModelMetrics() method.
    
    Returns:
    
    Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a 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

Class Recommender

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

recommenderArn

datasetGroupArn

name

recipeArn

recommenderConfig

creationDateTime

lastUpdatedDateTime

status

failureReason

latestRecommenderUpdate

hasModelMetrics

modelMetrics

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields