/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Personalize { namespace Model { /** *

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 Reference

*/ class Recommender { public: AWS_PERSONALIZE_API Recommender(); AWS_PERSONALIZE_API Recommender(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API Recommender& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline const Aws::String& GetRecommenderArn() const{ return m_recommenderArn; } /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline bool RecommenderArnHasBeenSet() const { return m_recommenderArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline void SetRecommenderArn(const Aws::String& value) { m_recommenderArnHasBeenSet = true; m_recommenderArn = value; } /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline void SetRecommenderArn(Aws::String&& value) { m_recommenderArnHasBeenSet = true; m_recommenderArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline void SetRecommenderArn(const char* value) { m_recommenderArnHasBeenSet = true; m_recommenderArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline Recommender& WithRecommenderArn(const Aws::String& value) { SetRecommenderArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline Recommender& WithRecommenderArn(Aws::String&& value) { SetRecommenderArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the recommender.

*/ inline Recommender& WithRecommenderArn(const char* value) { SetRecommenderArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetDatasetGroupArn() const{ return m_datasetGroupArn; } /** *

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

*/ inline bool DatasetGroupArnHasBeenSet() const { return m_datasetGroupArnHasBeenSet; } /** *

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

*/ inline void SetDatasetGroupArn(const Aws::String& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = value; } /** *

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

*/ inline void SetDatasetGroupArn(Aws::String&& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = std::move(value); } /** *

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

*/ inline void SetDatasetGroupArn(const char* value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn.assign(value); } /** *

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

*/ inline Recommender& WithDatasetGroupArn(const Aws::String& value) { SetDatasetGroupArn(value); return *this;} /** *

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

*/ inline Recommender& WithDatasetGroupArn(Aws::String&& value) { SetDatasetGroupArn(std::move(value)); return *this;} /** *

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

*/ inline Recommender& WithDatasetGroupArn(const char* value) { SetDatasetGroupArn(value); return *this;} /** *

The name of the recommender.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the recommender.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the recommender.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the recommender.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the recommender.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the recommender.

*/ inline Recommender& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the recommender.

*/ inline Recommender& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the recommender.

*/ inline Recommender& WithName(const char* value) { SetName(value); return *this;} /** *

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

*/ inline const Aws::String& GetRecipeArn() const{ return m_recipeArn; } /** *

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

*/ inline bool RecipeArnHasBeenSet() const { return m_recipeArnHasBeenSet; } /** *

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

*/ inline void SetRecipeArn(const Aws::String& value) { m_recipeArnHasBeenSet = true; m_recipeArn = value; } /** *

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

*/ inline void SetRecipeArn(Aws::String&& value) { m_recipeArnHasBeenSet = true; m_recipeArn = std::move(value); } /** *

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

*/ inline void SetRecipeArn(const char* value) { m_recipeArnHasBeenSet = true; m_recipeArn.assign(value); } /** *

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

*/ inline Recommender& WithRecipeArn(const Aws::String& value) { SetRecipeArn(value); return *this;} /** *

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

*/ inline Recommender& WithRecipeArn(Aws::String&& value) { SetRecipeArn(std::move(value)); return *this;} /** *

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

*/ inline Recommender& WithRecipeArn(const char* value) { SetRecipeArn(value); return *this;} /** *

The configuration details of the recommender.

*/ inline const RecommenderConfig& GetRecommenderConfig() const{ return m_recommenderConfig; } /** *

The configuration details of the recommender.

*/ inline bool RecommenderConfigHasBeenSet() const { return m_recommenderConfigHasBeenSet; } /** *

The configuration details of the recommender.

*/ inline void SetRecommenderConfig(const RecommenderConfig& value) { m_recommenderConfigHasBeenSet = true; m_recommenderConfig = value; } /** *

The configuration details of the recommender.

*/ inline void SetRecommenderConfig(RecommenderConfig&& value) { m_recommenderConfigHasBeenSet = true; m_recommenderConfig = std::move(value); } /** *

The configuration details of the recommender.

*/ inline Recommender& WithRecommenderConfig(const RecommenderConfig& value) { SetRecommenderConfig(value); return *this;} /** *

The configuration details of the recommender.

*/ inline Recommender& WithRecommenderConfig(RecommenderConfig&& value) { SetRecommenderConfig(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetCreationDateTime() const{ return m_creationDateTime; } /** *

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

*/ inline bool CreationDateTimeHasBeenSet() const { return m_creationDateTimeHasBeenSet; } /** *

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

*/ inline void SetCreationDateTime(const Aws::Utils::DateTime& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = value; } /** *

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

*/ inline void SetCreationDateTime(Aws::Utils::DateTime&& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = std::move(value); } /** *

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

*/ inline Recommender& WithCreationDateTime(const Aws::Utils::DateTime& value) { SetCreationDateTime(value); return *this;} /** *

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

*/ inline Recommender& WithCreationDateTime(Aws::Utils::DateTime&& value) { SetCreationDateTime(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetLastUpdatedDateTime() const{ return m_lastUpdatedDateTime; } /** *

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

*/ inline bool LastUpdatedDateTimeHasBeenSet() const { return m_lastUpdatedDateTimeHasBeenSet; } /** *

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

*/ inline void SetLastUpdatedDateTime(const Aws::Utils::DateTime& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = value; } /** *

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

*/ inline void SetLastUpdatedDateTime(Aws::Utils::DateTime&& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = std::move(value); } /** *

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

*/ inline Recommender& WithLastUpdatedDateTime(const Aws::Utils::DateTime& value) { SetLastUpdatedDateTime(value); return *this;} /** *

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

*/ inline Recommender& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); 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

*/ inline const Aws::String& GetStatus() const{ return m_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

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

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

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

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

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

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

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

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

*/ inline Recommender& WithStatus(const Aws::String& value) { SetStatus(value); 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

*/ inline Recommender& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); 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

*/ inline Recommender& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

If a recommender fails, the reason behind the failure.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

If a recommender fails, the reason behind the failure.

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

If a recommender fails, the reason behind the failure.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

If a recommender fails, the reason behind the failure.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

If a recommender fails, the reason behind the failure.

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

If a recommender fails, the reason behind the failure.

*/ inline Recommender& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

If a recommender fails, the reason behind the failure.

*/ inline Recommender& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

If a recommender fails, the reason behind the failure.

*/ inline Recommender& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

Provides a summary of the latest updates to the recommender.

*/ inline const RecommenderUpdateSummary& GetLatestRecommenderUpdate() const{ return m_latestRecommenderUpdate; } /** *

Provides a summary of the latest updates to the recommender.

*/ inline bool LatestRecommenderUpdateHasBeenSet() const { return m_latestRecommenderUpdateHasBeenSet; } /** *

Provides a summary of the latest updates to the recommender.

*/ inline void SetLatestRecommenderUpdate(const RecommenderUpdateSummary& value) { m_latestRecommenderUpdateHasBeenSet = true; m_latestRecommenderUpdate = value; } /** *

Provides a summary of the latest updates to the recommender.

*/ inline void SetLatestRecommenderUpdate(RecommenderUpdateSummary&& value) { m_latestRecommenderUpdateHasBeenSet = true; m_latestRecommenderUpdate = std::move(value); } /** *

Provides a summary of the latest updates to the recommender.

*/ inline Recommender& WithLatestRecommenderUpdate(const RecommenderUpdateSummary& value) { SetLatestRecommenderUpdate(value); return *this;} /** *

Provides a summary of the latest updates to the recommender.

*/ inline Recommender& WithLatestRecommenderUpdate(RecommenderUpdateSummary&& value) { SetLatestRecommenderUpdate(std::move(value)); return *this;} /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline const Aws::Map& GetModelMetrics() const{ return m_modelMetrics; } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline bool ModelMetricsHasBeenSet() const { return m_modelMetricsHasBeenSet; } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline void SetModelMetrics(const Aws::Map& value) { m_modelMetricsHasBeenSet = true; m_modelMetrics = value; } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline void SetModelMetrics(Aws::Map&& value) { m_modelMetricsHasBeenSet = true; m_modelMetrics = std::move(value); } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline Recommender& WithModelMetrics(const Aws::Map& value) { SetModelMetrics(value); return *this;} /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline Recommender& WithModelMetrics(Aws::Map&& value) { SetModelMetrics(std::move(value)); return *this;} /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline Recommender& AddModelMetrics(const Aws::String& key, double value) { m_modelMetricsHasBeenSet = true; m_modelMetrics.emplace(key, value); return *this; } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline Recommender& AddModelMetrics(Aws::String&& key, double value) { m_modelMetricsHasBeenSet = true; m_modelMetrics.emplace(std::move(key), value); return *this; } /** *

Provides evaluation metrics that help you determine the performance of a * recommender. For more information, see * Evaluating a recommender.

*/ inline Recommender& AddModelMetrics(const char* key, double value) { m_modelMetricsHasBeenSet = true; m_modelMetrics.emplace(key, value); return *this; } private: Aws::String m_recommenderArn; bool m_recommenderArnHasBeenSet = false; Aws::String m_datasetGroupArn; bool m_datasetGroupArnHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_recipeArn; bool m_recipeArnHasBeenSet = false; RecommenderConfig m_recommenderConfig; bool m_recommenderConfigHasBeenSet = false; Aws::Utils::DateTime m_creationDateTime; bool m_creationDateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDateTime; bool m_lastUpdatedDateTimeHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; RecommenderUpdateSummary m_latestRecommenderUpdate; bool m_latestRecommenderUpdateHasBeenSet = false; Aws::Map m_modelMetrics; bool m_modelMetricsHasBeenSet = false; }; } // namespace Model } // namespace Personalize } // namespace Aws