Recommender (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.Recommender

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Recommender
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Recommender()

Constructors
Constructor and Description
`Recommender()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Recommender`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationDateTime()` The date and time (in Unix format) that the recommender was created.
`String`	`getDatasetGroupArn()` The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
`String`	`getFailureReason()` If a recommender fails, the reason behind the failure.
`Date`	`getLastUpdatedDateTime()` The date and time (in Unix format) that the recommender was last updated.
`RecommenderUpdateSummary`	`getLatestRecommenderUpdate()` Provides a summary of the latest updates to the recommender.
`String`	`getName()` The name of the recommender.
`String`	`getRecipeArn()` The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
`String`	`getRecommenderArn()` The Amazon Resource Name (ARN) of the recommender.
`RecommenderConfig`	`getRecommenderConfig()` The configuration details of the recommender.
`String`	`getStatus()` The status of the recommender.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationDateTime(Date creationDateTime)` The date and time (in Unix format) that the recommender was created.
`void`	`setDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
`void`	`setFailureReason(String failureReason)` If a recommender fails, the reason behind the failure.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix format) that the recommender was last updated.
`void`	`setLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate)` Provides a summary of the latest updates to the recommender.
`void`	`setName(String name)` The name of the recommender.
`void`	`setRecipeArn(String recipeArn)` The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
`void`	`setRecommenderArn(String recommenderArn)` The Amazon Resource Name (ARN) of the recommender.
`void`	`setRecommenderConfig(RecommenderConfig recommenderConfig)` The configuration details of the recommender.
`void`	`setStatus(String status)` The status of the recommender.
`String`	`toString()` Returns a string representation of this object.
`Recommender`	`withCreationDateTime(Date creationDateTime)` The date and time (in Unix format) that the recommender was created.
`Recommender`	`withDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
`Recommender`	`withFailureReason(String failureReason)` If a recommender fails, the reason behind the failure.
`Recommender`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix format) that the recommender was last updated.
`Recommender`	`withLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate)` Provides a summary of the latest updates to the recommender.
`Recommender`	`withName(String name)` The name of the recommender.
`Recommender`	`withRecipeArn(String recipeArn)` The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
`Recommender`	`withRecommenderArn(String recommenderArn)` The Amazon Resource Name (ARN) of the recommender.
`Recommender`	`withRecommenderConfig(RecommenderConfig recommenderConfig)` The configuration details of the recommender.
`Recommender`	`withStatus(String status)` The status of the recommender.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Recommender
```
public Recommender()
```
- Method Detail
  - setRecommenderArn
```
public void setRecommenderArn(String recommenderArn)
```
    The Amazon Resource Name (ARN) of the recommender.
    
    Parameters:
    
    recommenderArn - The Amazon Resource Name (ARN) of the recommender.
  - getRecommenderArn
```
public String getRecommenderArn()
```
    The Amazon Resource Name (ARN) of the recommender.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the recommender.
  - withRecommenderArn
```
public Recommender withRecommenderArn(String recommenderArn)
```
    The Amazon Resource Name (ARN) of the recommender.
    
    Parameters:
    
    recommenderArn - The Amazon Resource Name (ARN) of the recommender.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetGroupArn
```
public void setDatasetGroupArn(String datasetGroupArn)
```
    The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
  - getDatasetGroupArn
```
public String getDatasetGroupArn()
```
    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.
  - withDatasetGroupArn
```
public Recommender withDatasetGroupArn(String datasetGroupArn)
```
    The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
    
    Parameters:
    
    datasetGroupArn - The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the recommender.
    
    Parameters:
    
    name - The name of the recommender.
  - getName
```
public String getName()
```
    The name of the recommender.
    
    Returns:
    
    The name of the recommender.
  - withName
```
public Recommender withName(String name)
```
    The name of the recommender.
    
    Parameters:
    
    name - The name of the recommender.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecipeArn
```
public void setRecipeArn(String recipeArn)
```
    The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
    
    Parameters:
    
    recipeArn - The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
  - getRecipeArn
```
public String getRecipeArn()
```
    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.
  - withRecipeArn
```
public Recommender withRecipeArn(String recipeArn)
```
    The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
    
    Parameters:
    
    recipeArn - The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecommenderConfig
```
public void setRecommenderConfig(RecommenderConfig recommenderConfig)
```
    The configuration details of the recommender.
    
    Parameters:
    
    recommenderConfig - The configuration details of the recommender.
  - getRecommenderConfig
```
public RecommenderConfig getRecommenderConfig()
```
    The configuration details of the recommender.
    
    Returns:
    
    The configuration details of the recommender.
  - withRecommenderConfig
```
public Recommender withRecommenderConfig(RecommenderConfig recommenderConfig)
```
    The configuration details of the recommender.
    
    Parameters:
    
    recommenderConfig - The configuration details of the recommender.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix format) that the recommender was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix format) that the recommender was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    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.
  - withCreationDateTime
```
public Recommender withCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix format) that the recommender was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix format) that the recommender was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix format) that the recommender was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix format) that the recommender was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    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.
  - withLastUpdatedDateTime
```
public Recommender withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix format) that the recommender was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix format) that the recommender was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(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
    Parameters:
    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
  - getStatus
```
public String getStatus()
```
    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
  - withStatus
```
public Recommender withStatus(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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If a recommender fails, the reason behind the failure.
    
    Parameters:
    
    failureReason - If a recommender fails, the reason behind the failure.
  - getFailureReason
```
public String getFailureReason()
```
    If a recommender fails, the reason behind the failure.
    
    Returns:
    
    If a recommender fails, the reason behind the failure.
  - withFailureReason
```
public Recommender withFailureReason(String failureReason)
```
    If a recommender fails, the reason behind the failure.
    
    Parameters:
    
    failureReason - If a recommender fails, the reason behind the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestRecommenderUpdate
```
public void setLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate)
```
    Provides a summary of the latest updates to the recommender.
    
    Parameters:
    
    latestRecommenderUpdate - Provides a summary of the latest updates to the recommender.
  - getLatestRecommenderUpdate
```
public RecommenderUpdateSummary getLatestRecommenderUpdate()
```
    Provides a summary of the latest updates to the recommender.
    
    Returns:
    
    Provides a summary of the latest updates to the recommender.
  - withLatestRecommenderUpdate
```
public Recommender withLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate)
```
    Provides a summary of the latest updates to the recommender.
    
    Parameters:
    
    latestRecommenderUpdate - Provides a summary of the latest updates to the recommender.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Recommender clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Recommender

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Recommender

Method Detail

setRecommenderArn

getRecommenderArn

withRecommenderArn

setDatasetGroupArn

getDatasetGroupArn

withDatasetGroupArn

setName

getName

withName

setRecipeArn

getRecipeArn

withRecipeArn

setRecommenderConfig

getRecommenderConfig

withRecommenderConfig

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

setStatus

getStatus

withStatus

setFailureReason

getFailureReason

withFailureReason

setLatestRecommenderUpdate

getLatestRecommenderUpdate

withLatestRecommenderUpdate

toString

equals

hashCode

clone

marshall