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

An object that describes the deployment of a solution version. For more * information on campaigns, see CreateCampaign.

See * Also:

AWS * API Reference

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

*/ inline const Aws::String& GetCampaignArn() const{ return m_campaignArn; } /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline bool CampaignArnHasBeenSet() const { return m_campaignArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline void SetCampaignArn(const Aws::String& value) { m_campaignArnHasBeenSet = true; m_campaignArn = value; } /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline void SetCampaignArn(Aws::String&& value) { m_campaignArnHasBeenSet = true; m_campaignArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline void SetCampaignArn(const char* value) { m_campaignArnHasBeenSet = true; m_campaignArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline Campaign& WithCampaignArn(const Aws::String& value) { SetCampaignArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline Campaign& WithCampaignArn(Aws::String&& value) { SetCampaignArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the campaign.

*/ inline Campaign& WithCampaignArn(const char* value) { SetCampaignArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline const Aws::String& GetSolutionVersionArn() const{ return m_solutionVersionArn; } /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline bool SolutionVersionArnHasBeenSet() const { return m_solutionVersionArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline void SetSolutionVersionArn(const Aws::String& value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn = value; } /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline void SetSolutionVersionArn(Aws::String&& value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline void SetSolutionVersionArn(const char* value) { m_solutionVersionArnHasBeenSet = true; m_solutionVersionArn.assign(value); } /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline Campaign& WithSolutionVersionArn(const Aws::String& value) { SetSolutionVersionArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline Campaign& WithSolutionVersionArn(Aws::String&& value) { SetSolutionVersionArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of a specific version of the solution.

*/ inline Campaign& WithSolutionVersionArn(const char* value) { SetSolutionVersionArn(value); return *this;} /** *

Specifies the requested minimum provisioned transactions (recommendations) * per second. A high minProvisionedTPS will increase your bill. We * recommend starting with 1 for minProvisionedTPS (the default). * Track your usage using Amazon CloudWatch metrics, and increase the * minProvisionedTPS as necessary.

*/ inline int GetMinProvisionedTPS() const{ return m_minProvisionedTPS; } /** *

Specifies the requested minimum provisioned transactions (recommendations) * per second. A high minProvisionedTPS will increase your bill. We * recommend starting with 1 for minProvisionedTPS (the default). * Track your usage using Amazon CloudWatch metrics, and increase the * minProvisionedTPS as necessary.

*/ inline bool MinProvisionedTPSHasBeenSet() const { return m_minProvisionedTPSHasBeenSet; } /** *

Specifies the requested minimum provisioned transactions (recommendations) * per second. A high minProvisionedTPS will increase your bill. We * recommend starting with 1 for minProvisionedTPS (the default). * Track your usage using Amazon CloudWatch metrics, and increase the * minProvisionedTPS as necessary.

*/ inline void SetMinProvisionedTPS(int value) { m_minProvisionedTPSHasBeenSet = true; m_minProvisionedTPS = value; } /** *

Specifies the requested minimum provisioned transactions (recommendations) * per second. A high minProvisionedTPS will increase your bill. We * recommend starting with 1 for minProvisionedTPS (the default). * Track your usage using Amazon CloudWatch metrics, and increase the * minProvisionedTPS as necessary.

*/ inline Campaign& WithMinProvisionedTPS(int value) { SetMinProvisionedTPS(value); return *this;} /** *

The configuration details of a campaign.

*/ inline const CampaignConfig& GetCampaignConfig() const{ return m_campaignConfig; } /** *

The configuration details of a campaign.

*/ inline bool CampaignConfigHasBeenSet() const { return m_campaignConfigHasBeenSet; } /** *

The configuration details of a campaign.

*/ inline void SetCampaignConfig(const CampaignConfig& value) { m_campaignConfigHasBeenSet = true; m_campaignConfig = value; } /** *

The configuration details of a campaign.

*/ inline void SetCampaignConfig(CampaignConfig&& value) { m_campaignConfigHasBeenSet = true; m_campaignConfig = std::move(value); } /** *

The configuration details of a campaign.

*/ inline Campaign& WithCampaignConfig(const CampaignConfig& value) { SetCampaignConfig(value); return *this;} /** *

The configuration details of a campaign.

*/ inline Campaign& WithCampaignConfig(CampaignConfig&& value) { SetCampaignConfig(std::move(value)); return *this;} /** *

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

    • *
*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

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

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

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

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

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

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

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

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

    • *
*/ inline Campaign& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

    • *
*/ inline Campaign& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the campaign.

A campaign can be in one of the following * states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- * CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

If a campaign fails, the reason behind the failure.

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

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

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

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

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

The date and time (in Unix format) that the campaign 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 campaign 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 campaign was created.

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

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

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

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

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

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

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

The date and time (in Unix format) that the campaign 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 campaign 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 campaign was last updated.

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

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

*/ inline Campaign& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); return *this;} inline const CampaignUpdateSummary& GetLatestCampaignUpdate() const{ return m_latestCampaignUpdate; } inline bool LatestCampaignUpdateHasBeenSet() const { return m_latestCampaignUpdateHasBeenSet; } inline void SetLatestCampaignUpdate(const CampaignUpdateSummary& value) { m_latestCampaignUpdateHasBeenSet = true; m_latestCampaignUpdate = value; } inline void SetLatestCampaignUpdate(CampaignUpdateSummary&& value) { m_latestCampaignUpdateHasBeenSet = true; m_latestCampaignUpdate = std::move(value); } inline Campaign& WithLatestCampaignUpdate(const CampaignUpdateSummary& value) { SetLatestCampaignUpdate(value); return *this;} inline Campaign& WithLatestCampaignUpdate(CampaignUpdateSummary&& value) { SetLatestCampaignUpdate(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_campaignArn; bool m_campaignArnHasBeenSet = false; Aws::String m_solutionVersionArn; bool m_solutionVersionArnHasBeenSet = false; int m_minProvisionedTPS; bool m_minProvisionedTPSHasBeenSet = false; CampaignConfig m_campaignConfig; bool m_campaignConfigHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; Aws::Utils::DateTime m_creationDateTime; bool m_creationDateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDateTime; bool m_lastUpdatedDateTimeHasBeenSet = false; CampaignUpdateSummary m_latestCampaignUpdate; bool m_latestCampaignUpdateHasBeenSet = false; }; } // namespace Model } // namespace Personalize } // namespace Aws