/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.personalize.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Recommender implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) of the recommender. *
*/ private String recommenderArn; /** ** The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. *
*/ private String datasetGroupArn; /** ** The name of the recommender. *
*/ private String name; /** ** The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created * for. *
*/ private String recipeArn; /** ** The configuration details of the recommender. *
*/ private RecommenderConfig recommenderConfig; /** ** The date and time (in Unix format) that the recommender was created. *
*/ private java.util.Date creationDateTime; /** ** The date and time (in Unix format) that the recommender was last updated. *
*/ private java.util.Date lastUpdatedDateTime; /** ** 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 *
** If a recommender fails, the reason behind the failure. *
*/ private String failureReason; /** ** Provides a summary of the latest updates to the recommender. *
*/ private RecommenderUpdateSummary latestRecommenderUpdate; /** ** Provides evaluation metrics that help you determine the performance of a recommender. For more information, see * Evaluating a * recommender. *
*/ private java.util.Map* The Amazon Resource Name (ARN) of the recommender. *
* * @param recommenderArn * The Amazon Resource Name (ARN) of the recommender. */ public void setRecommenderArn(String recommenderArn) { this.recommenderArn = recommenderArn; } /** ** The Amazon Resource Name (ARN) of the recommender. *
* * @return The Amazon Resource Name (ARN) of the recommender. */ public String getRecommenderArn() { return this.recommenderArn; } /** ** The Amazon Resource Name (ARN) of the recommender. *
* * @param recommenderArn * The Amazon Resource Name (ARN) of the recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withRecommenderArn(String recommenderArn) { setRecommenderArn(recommenderArn); return this; } /** ** The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. *
* * @param datasetGroupArn * The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. */ public void setDatasetGroupArn(String datasetGroupArn) { this.datasetGroupArn = datasetGroupArn; } /** ** The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. *
* * @return The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. */ public String getDatasetGroupArn() { return this.datasetGroupArn; } /** ** The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. *
* * @param datasetGroupArn * The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withDatasetGroupArn(String datasetGroupArn) { setDatasetGroupArn(datasetGroupArn); return this; } /** ** The name of the recommender. *
* * @param name * The name of the recommender. */ public void setName(String name) { this.name = name; } /** ** The name of the recommender. *
* * @return The name of the recommender. */ public String getName() { return this.name; } /** ** The name of the recommender. *
* * @param name * The name of the recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withName(String name) { setName(name); return this; } /** ** The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created * for. *
* * @param recipeArn * The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was * created for. */ public void setRecipeArn(String recipeArn) { this.recipeArn = recipeArn; } /** ** The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created * for. *
* * @return The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was * created for. */ public String getRecipeArn() { return this.recipeArn; } /** ** The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created * for. *
* * @param recipeArn * The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was * created for. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withRecipeArn(String recipeArn) { setRecipeArn(recipeArn); return this; } /** ** The configuration details of the recommender. *
* * @param recommenderConfig * The configuration details of the recommender. */ public void setRecommenderConfig(RecommenderConfig recommenderConfig) { this.recommenderConfig = recommenderConfig; } /** ** The configuration details of the recommender. *
* * @return The configuration details of the recommender. */ public RecommenderConfig getRecommenderConfig() { return this.recommenderConfig; } /** ** The configuration details of the recommender. *
* * @param recommenderConfig * The configuration details of the recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withRecommenderConfig(RecommenderConfig recommenderConfig) { setRecommenderConfig(recommenderConfig); return this; } /** ** The date and time (in Unix format) that the recommender was created. *
* * @param creationDateTime * The date and time (in Unix format) that the recommender was created. */ public void setCreationDateTime(java.util.Date creationDateTime) { this.creationDateTime = creationDateTime; } /** ** The date and time (in Unix format) that the recommender was created. *
* * @return The date and time (in Unix format) that the recommender was created. */ public java.util.Date getCreationDateTime() { return this.creationDateTime; } /** ** The date and time (in Unix format) that the recommender was created. *
* * @param creationDateTime * The date and time (in Unix format) that the recommender was created. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withCreationDateTime(java.util.Date creationDateTime) { setCreationDateTime(creationDateTime); return this; } /** ** The date and time (in Unix format) that the recommender was last updated. *
* * @param lastUpdatedDateTime * The date and time (in Unix format) that the recommender was last updated. */ public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { this.lastUpdatedDateTime = lastUpdatedDateTime; } /** ** The date and time (in Unix format) that the recommender was last updated. *
* * @return The date and time (in Unix format) that the recommender was last updated. */ public java.util.Date getLastUpdatedDateTime() { return this.lastUpdatedDateTime; } /** ** The date and time (in Unix format) that the recommender was last updated. *
* * @param lastUpdatedDateTime * The date and time (in Unix format) that the recommender was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { setLastUpdatedDateTime(lastUpdatedDateTime); return this; } /** ** 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 *
** 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 *
** 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 *
** 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 *
** 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 *
** 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 *
** If a recommender fails, the reason behind the failure. *
* * @param failureReason * If a recommender fails, the reason behind the failure. */ public void setFailureReason(String failureReason) { this.failureReason = failureReason; } /** ** If a recommender fails, the reason behind the failure. *
* * @return If a recommender fails, the reason behind the failure. */ public String getFailureReason() { return this.failureReason; } /** ** If a recommender fails, the reason behind the failure. *
* * @param failureReason * If a recommender fails, the reason behind the failure. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withFailureReason(String failureReason) { setFailureReason(failureReason); return this; } /** ** Provides a summary of the latest updates to the recommender. *
* * @param latestRecommenderUpdate * Provides a summary of the latest updates to the recommender. */ public void setLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate) { this.latestRecommenderUpdate = latestRecommenderUpdate; } /** ** Provides a summary of the latest updates to the recommender. *
* * @return Provides a summary of the latest updates to the recommender. */ public RecommenderUpdateSummary getLatestRecommenderUpdate() { return this.latestRecommenderUpdate; } /** ** Provides a summary of the latest updates to the recommender. *
* * @param latestRecommenderUpdate * Provides a summary of the latest updates to the recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withLatestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate) { setLatestRecommenderUpdate(latestRecommenderUpdate); return this; } /** ** Provides evaluation metrics that help you determine the performance of a recommender. For more information, see * Evaluating a * recommender. *
* * @return Provides evaluation metrics that help you determine the performance of a recommender. For more * information, see Evaluating a * recommender. */ public java.util.Map* Provides evaluation metrics that help you determine the performance of a recommender. For more information, see * Evaluating a * recommender. *
* * @param modelMetrics * Provides evaluation metrics that help you determine the performance of a recommender. For more * information, see * Evaluating a recommender. */ public void setModelMetrics(java.util.Map* Provides evaluation metrics that help you determine the performance of a recommender. For more information, see * Evaluating a * recommender. *
* * @param modelMetrics * Provides evaluation metrics that help you determine the performance of a recommender. For more * information, see * Evaluating a recommender. * @return Returns a reference to this object so that method calls can be chained together. */ public Recommender withModelMetrics(java.util.Map