/** * 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 IoTFleetWise { namespace Model { /** */ class UpdateCampaignRequest : public IoTFleetWiseRequest { public: AWS_IOTFLEETWISE_API UpdateCampaignRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateCampaign"; } AWS_IOTFLEETWISE_API Aws::String SerializePayload() const override; AWS_IOTFLEETWISE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

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

The name of the campaign to update.

*/ inline UpdateCampaignRequest& 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 UpdateCampaignRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the campaign.

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

The description of the campaign.

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

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline const Aws::Vector& GetDataExtraDimensions() const{ return m_dataExtraDimensions; } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline bool DataExtraDimensionsHasBeenSet() const { return m_dataExtraDimensionsHasBeenSet; } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline void SetDataExtraDimensions(const Aws::Vector& value) { m_dataExtraDimensionsHasBeenSet = true; m_dataExtraDimensions = value; } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline void SetDataExtraDimensions(Aws::Vector&& value) { m_dataExtraDimensionsHasBeenSet = true; m_dataExtraDimensions = std::move(value); } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline UpdateCampaignRequest& WithDataExtraDimensions(const Aws::Vector& value) { SetDataExtraDimensions(value); return *this;} /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline UpdateCampaignRequest& WithDataExtraDimensions(Aws::Vector&& value) { SetDataExtraDimensions(std::move(value)); return *this;} /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline UpdateCampaignRequest& AddDataExtraDimensions(const Aws::String& value) { m_dataExtraDimensionsHasBeenSet = true; m_dataExtraDimensions.push_back(value); return *this; } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline UpdateCampaignRequest& AddDataExtraDimensions(Aws::String&& value) { m_dataExtraDimensionsHasBeenSet = true; m_dataExtraDimensions.push_back(std::move(value)); return *this; } /** *

A list of vehicle attributes to associate with a signal.

Default: An * empty array

*/ inline UpdateCampaignRequest& AddDataExtraDimensions(const char* value) { m_dataExtraDimensionsHasBeenSet = true; m_dataExtraDimensions.push_back(value); return *this; } /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline const UpdateCampaignAction& GetAction() const{ return m_action; } /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; } /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline void SetAction(const UpdateCampaignAction& value) { m_actionHasBeenSet = true; m_action = value; } /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline void SetAction(UpdateCampaignAction&& value) { m_actionHasBeenSet = true; m_action = std::move(value); } /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline UpdateCampaignRequest& WithAction(const UpdateCampaignAction& value) { SetAction(value); return *this;} /** *

Specifies how to update a campaign. The action can be one of the * following:

  • APPROVE - To approve delivering a data * collection scheme to vehicles.

  • SUSPEND - To * suspend collecting signal data. The campaign is deleted from vehicles and all * vehicles in the suspended campaign will stop sending data.

  • * RESUME - To reactivate the SUSPEND campaign. The * campaign is redeployed to all vehicles and the vehicles will resume sending * data.

  • UPDATE - To update a campaign.

  • *
*/ inline UpdateCampaignRequest& WithAction(UpdateCampaignAction&& value) { SetAction(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::Vector m_dataExtraDimensions; bool m_dataExtraDimensionsHasBeenSet = false; UpdateCampaignAction m_action; bool m_actionHasBeenSet = false; }; } // namespace Model } // namespace IoTFleetWise } // namespace Aws