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

Information about a campaign.

You can use the API operation to return * this information about multiple created campaigns.

See Also:

AWS * API Reference

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

The Amazon Resource Name (ARN) of a campaign.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline CampaignSummary& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline CampaignSummary& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of a campaign.

*/ inline CampaignSummary& WithArn(const char* value) { SetArn(value); return *this;} /** *

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The description of the campaign.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the campaign.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description of the campaign.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description of the campaign.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description of the campaign.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description of the campaign.

*/ inline CampaignSummary& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the campaign.

*/ inline CampaignSummary& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the campaign.

*/ inline CampaignSummary& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The ARN of the signal catalog associated with the campaign.

*/ inline const Aws::String& GetSignalCatalogArn() const{ return m_signalCatalogArn; } /** *

The ARN of the signal catalog associated with the campaign.

*/ inline bool SignalCatalogArnHasBeenSet() const { return m_signalCatalogArnHasBeenSet; } /** *

The ARN of the signal catalog associated with the campaign.

*/ inline void SetSignalCatalogArn(const Aws::String& value) { m_signalCatalogArnHasBeenSet = true; m_signalCatalogArn = value; } /** *

The ARN of the signal catalog associated with the campaign.

*/ inline void SetSignalCatalogArn(Aws::String&& value) { m_signalCatalogArnHasBeenSet = true; m_signalCatalogArn = std::move(value); } /** *

The ARN of the signal catalog associated with the campaign.

*/ inline void SetSignalCatalogArn(const char* value) { m_signalCatalogArnHasBeenSet = true; m_signalCatalogArn.assign(value); } /** *

The ARN of the signal catalog associated with the campaign.

*/ inline CampaignSummary& WithSignalCatalogArn(const Aws::String& value) { SetSignalCatalogArn(value); return *this;} /** *

The ARN of the signal catalog associated with the campaign.

*/ inline CampaignSummary& WithSignalCatalogArn(Aws::String&& value) { SetSignalCatalogArn(std::move(value)); return *this;} /** *

The ARN of the signal catalog associated with the campaign.

*/ inline CampaignSummary& WithSignalCatalogArn(const char* value) { SetSignalCatalogArn(value); return *this;} /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline const Aws::String& GetTargetArn() const{ return m_targetArn; } /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline bool TargetArnHasBeenSet() const { return m_targetArnHasBeenSet; } /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline void SetTargetArn(const Aws::String& value) { m_targetArnHasBeenSet = true; m_targetArn = value; } /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline void SetTargetArn(Aws::String&& value) { m_targetArnHasBeenSet = true; m_targetArn = std::move(value); } /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline void SetTargetArn(const char* value) { m_targetArnHasBeenSet = true; m_targetArn.assign(value); } /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline CampaignSummary& WithTargetArn(const Aws::String& value) { SetTargetArn(value); return *this;} /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline CampaignSummary& WithTargetArn(Aws::String&& value) { SetTargetArn(std::move(value)); return *this;} /** *

The ARN of a vehicle or fleet to which the campaign is deployed.

*/ inline CampaignSummary& WithTargetArn(const char* value) { SetTargetArn(value); return *this;} /** *

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

    • *
*/ inline const CampaignStatus& GetStatus() const{ return m_status; } /** *

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

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

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

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

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

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

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

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

The state of a campaign. The status can be one of the following:

    *

  • CREATING - Amazon Web Services IoT FleetWise is processing * your request to create the campaign.

  • * WAITING_FOR_APPROVAL - After a campaign is created, it enters the * WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT * FleetWise to deploy the campaign to the target vehicle or fleet, use the API * operation to approve the campaign.

  • RUNNING - * The campaign is active.

  • SUSPENDED - The * campaign is suspended. To resume the campaign, use the API operation.

    • *
*/ inline CampaignSummary& WithStatus(CampaignStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The time the campaign was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The time the campaign was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The time the campaign was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

The time the campaign was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

The time the campaign was created.

*/ inline CampaignSummary& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The time the campaign was created.

*/ inline CampaignSummary& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The last time the campaign was modified.

*/ inline const Aws::Utils::DateTime& GetLastModificationTime() const{ return m_lastModificationTime; } /** *

The last time the campaign was modified.

*/ inline bool LastModificationTimeHasBeenSet() const { return m_lastModificationTimeHasBeenSet; } /** *

The last time the campaign was modified.

*/ inline void SetLastModificationTime(const Aws::Utils::DateTime& value) { m_lastModificationTimeHasBeenSet = true; m_lastModificationTime = value; } /** *

The last time the campaign was modified.

*/ inline void SetLastModificationTime(Aws::Utils::DateTime&& value) { m_lastModificationTimeHasBeenSet = true; m_lastModificationTime = std::move(value); } /** *

The last time the campaign was modified.

*/ inline CampaignSummary& WithLastModificationTime(const Aws::Utils::DateTime& value) { SetLastModificationTime(value); return *this;} /** *

The last time the campaign was modified.

*/ inline CampaignSummary& WithLastModificationTime(Aws::Utils::DateTime&& value) { SetLastModificationTime(std::move(value)); return *this;} private: Aws::String m_arn; bool m_arnHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_signalCatalogArn; bool m_signalCatalogArnHasBeenSet = false; Aws::String m_targetArn; bool m_targetArnHasBeenSet = false; CampaignStatus m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_lastModificationTime; bool m_lastModificationTimeHasBeenSet = false; }; } // namespace Model } // namespace IoTFleetWise } // namespace Aws