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

Provides information about an activity that was performed by a * campaign.

See Also:

AWS * API Reference

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

The unique identifier for the application that the campaign applies to.

*/ inline const Aws::String& GetApplicationId() const{ return m_applicationId; } /** *

The unique identifier for the application that the campaign applies to.

*/ inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; } /** *

The unique identifier for the application that the campaign applies to.

*/ inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; } /** *

The unique identifier for the application that the campaign applies to.

*/ inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); } /** *

The unique identifier for the application that the campaign applies to.

*/ inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); } /** *

The unique identifier for the application that the campaign applies to.

*/ inline ActivityResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;} /** *

The unique identifier for the application that the campaign applies to.

*/ inline ActivityResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;} /** *

The unique identifier for the application that the campaign applies to.

*/ inline ActivityResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;} /** *

The unique identifier for the campaign that the activity applies to.

*/ inline const Aws::String& GetCampaignId() const{ return m_campaignId; } /** *

The unique identifier for the campaign that the activity applies to.

*/ inline bool CampaignIdHasBeenSet() const { return m_campaignIdHasBeenSet; } /** *

The unique identifier for the campaign that the activity applies to.

*/ inline void SetCampaignId(const Aws::String& value) { m_campaignIdHasBeenSet = true; m_campaignId = value; } /** *

The unique identifier for the campaign that the activity applies to.

*/ inline void SetCampaignId(Aws::String&& value) { m_campaignIdHasBeenSet = true; m_campaignId = std::move(value); } /** *

The unique identifier for the campaign that the activity applies to.

*/ inline void SetCampaignId(const char* value) { m_campaignIdHasBeenSet = true; m_campaignId.assign(value); } /** *

The unique identifier for the campaign that the activity applies to.

*/ inline ActivityResponse& WithCampaignId(const Aws::String& value) { SetCampaignId(value); return *this;} /** *

The unique identifier for the campaign that the activity applies to.

*/ inline ActivityResponse& WithCampaignId(Aws::String&& value) { SetCampaignId(std::move(value)); return *this;} /** *

The unique identifier for the campaign that the activity applies to.

*/ inline ActivityResponse& WithCampaignId(const char* value) { SetCampaignId(value); return *this;} /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline const Aws::String& GetEnd() const{ return m_end; } /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline bool EndHasBeenSet() const { return m_endHasBeenSet; } /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline void SetEnd(const Aws::String& value) { m_endHasBeenSet = true; m_end = value; } /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline void SetEnd(Aws::String&& value) { m_endHasBeenSet = true; m_end = std::move(value); } /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline void SetEnd(const char* value) { m_endHasBeenSet = true; m_end.assign(value); } /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline ActivityResponse& WithEnd(const Aws::String& value) { SetEnd(value); return *this;} /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline ActivityResponse& WithEnd(Aws::String&& value) { SetEnd(std::move(value)); return *this;} /** *

The actual time, in ISO 8601 format, when the activity was marked CANCELLED * or COMPLETED.

*/ inline ActivityResponse& WithEnd(const char* value) { SetEnd(value); return *this;} /** *

The unique identifier for the activity.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The unique identifier for the activity.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The unique identifier for the activity.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

The unique identifier for the activity.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

The unique identifier for the activity.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

The unique identifier for the activity.

*/ inline ActivityResponse& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The unique identifier for the activity.

*/ inline ActivityResponse& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The unique identifier for the activity.

*/ inline ActivityResponse& WithId(const char* value) { SetId(value); return *this;} /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline const Aws::String& GetResult() const{ return m_result; } /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline bool ResultHasBeenSet() const { return m_resultHasBeenSet; } /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline void SetResult(const Aws::String& value) { m_resultHasBeenSet = true; m_result = value; } /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline void SetResult(Aws::String&& value) { m_resultHasBeenSet = true; m_result = std::move(value); } /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline void SetResult(const char* value) { m_resultHasBeenSet = true; m_result.assign(value); } /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline ActivityResponse& WithResult(const Aws::String& value) { SetResult(value); return *this;} /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline ActivityResponse& WithResult(Aws::String&& value) { SetResult(std::move(value)); return *this;} /** *

Specifies whether the activity succeeded. Possible values are SUCCESS and * FAIL.

*/ inline ActivityResponse& WithResult(const char* value) { SetResult(value); return *this;} /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline const Aws::String& GetScheduledStart() const{ return m_scheduledStart; } /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline bool ScheduledStartHasBeenSet() const { return m_scheduledStartHasBeenSet; } /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline void SetScheduledStart(const Aws::String& value) { m_scheduledStartHasBeenSet = true; m_scheduledStart = value; } /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline void SetScheduledStart(Aws::String&& value) { m_scheduledStartHasBeenSet = true; m_scheduledStart = std::move(value); } /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline void SetScheduledStart(const char* value) { m_scheduledStartHasBeenSet = true; m_scheduledStart.assign(value); } /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline ActivityResponse& WithScheduledStart(const Aws::String& value) { SetScheduledStart(value); return *this;} /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline ActivityResponse& WithScheduledStart(Aws::String&& value) { SetScheduledStart(std::move(value)); return *this;} /** *

The scheduled start time, in ISO 8601 format, for the activity.

*/ inline ActivityResponse& WithScheduledStart(const char* value) { SetScheduledStart(value); return *this;} /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline const Aws::String& GetStart() const{ return m_start; } /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline bool StartHasBeenSet() const { return m_startHasBeenSet; } /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline void SetStart(const Aws::String& value) { m_startHasBeenSet = true; m_start = value; } /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline void SetStart(Aws::String&& value) { m_startHasBeenSet = true; m_start = std::move(value); } /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline void SetStart(const char* value) { m_startHasBeenSet = true; m_start.assign(value); } /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline ActivityResponse& WithStart(const Aws::String& value) { SetStart(value); return *this;} /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline ActivityResponse& WithStart(Aws::String&& value) { SetStart(std::move(value)); return *this;} /** *

The actual start time, in ISO 8601 format, of the activity.

*/ inline ActivityResponse& WithStart(const char* value) { SetStart(value); return *this;} /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline const Aws::String& GetState() const{ return m_state; } /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline void SetState(const Aws::String& value) { m_stateHasBeenSet = true; m_state = value; } /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline void SetState(Aws::String&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline void SetState(const char* value) { m_stateHasBeenSet = true; m_state.assign(value); } /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline ActivityResponse& WithState(const Aws::String& value) { SetState(value); return *this;} /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline ActivityResponse& WithState(Aws::String&& value) { SetState(std::move(value)); return *this;} /** *

The current status of the activity. Possible values are: PENDING, * INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

*/ inline ActivityResponse& WithState(const char* value) { SetState(value); return *this;} /** *

The total number of endpoints that the campaign successfully delivered * messages to.

*/ inline int GetSuccessfulEndpointCount() const{ return m_successfulEndpointCount; } /** *

The total number of endpoints that the campaign successfully delivered * messages to.

*/ inline bool SuccessfulEndpointCountHasBeenSet() const { return m_successfulEndpointCountHasBeenSet; } /** *

The total number of endpoints that the campaign successfully delivered * messages to.

*/ inline void SetSuccessfulEndpointCount(int value) { m_successfulEndpointCountHasBeenSet = true; m_successfulEndpointCount = value; } /** *

The total number of endpoints that the campaign successfully delivered * messages to.

*/ inline ActivityResponse& WithSuccessfulEndpointCount(int value) { SetSuccessfulEndpointCount(value); return *this;} /** *

The total number of time zones that were completed.

*/ inline int GetTimezonesCompletedCount() const{ return m_timezonesCompletedCount; } /** *

The total number of time zones that were completed.

*/ inline bool TimezonesCompletedCountHasBeenSet() const { return m_timezonesCompletedCountHasBeenSet; } /** *

The total number of time zones that were completed.

*/ inline void SetTimezonesCompletedCount(int value) { m_timezonesCompletedCountHasBeenSet = true; m_timezonesCompletedCount = value; } /** *

The total number of time zones that were completed.

*/ inline ActivityResponse& WithTimezonesCompletedCount(int value) { SetTimezonesCompletedCount(value); return *this;} /** *

The total number of unique time zones that are in the segment for the * campaign.

*/ inline int GetTimezonesTotalCount() const{ return m_timezonesTotalCount; } /** *

The total number of unique time zones that are in the segment for the * campaign.

*/ inline bool TimezonesTotalCountHasBeenSet() const { return m_timezonesTotalCountHasBeenSet; } /** *

The total number of unique time zones that are in the segment for the * campaign.

*/ inline void SetTimezonesTotalCount(int value) { m_timezonesTotalCountHasBeenSet = true; m_timezonesTotalCount = value; } /** *

The total number of unique time zones that are in the segment for the * campaign.

*/ inline ActivityResponse& WithTimezonesTotalCount(int value) { SetTimezonesTotalCount(value); return *this;} /** *

The total number of endpoints that the campaign attempted to deliver messages * to.

*/ inline int GetTotalEndpointCount() const{ return m_totalEndpointCount; } /** *

The total number of endpoints that the campaign attempted to deliver messages * to.

*/ inline bool TotalEndpointCountHasBeenSet() const { return m_totalEndpointCountHasBeenSet; } /** *

The total number of endpoints that the campaign attempted to deliver messages * to.

*/ inline void SetTotalEndpointCount(int value) { m_totalEndpointCountHasBeenSet = true; m_totalEndpointCount = value; } /** *

The total number of endpoints that the campaign attempted to deliver messages * to.

*/ inline ActivityResponse& WithTotalEndpointCount(int value) { SetTotalEndpointCount(value); return *this;} /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline const Aws::String& GetTreatmentId() const{ return m_treatmentId; } /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline bool TreatmentIdHasBeenSet() const { return m_treatmentIdHasBeenSet; } /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline void SetTreatmentId(const Aws::String& value) { m_treatmentIdHasBeenSet = true; m_treatmentId = value; } /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline void SetTreatmentId(Aws::String&& value) { m_treatmentIdHasBeenSet = true; m_treatmentId = std::move(value); } /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline void SetTreatmentId(const char* value) { m_treatmentIdHasBeenSet = true; m_treatmentId.assign(value); } /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline ActivityResponse& WithTreatmentId(const Aws::String& value) { SetTreatmentId(value); return *this;} /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline ActivityResponse& WithTreatmentId(Aws::String&& value) { SetTreatmentId(std::move(value)); return *this;} /** *

The unique identifier for the campaign treatment that the activity applies * to. A treatment is a variation of a campaign that's used for A/B testing of a * campaign.

*/ inline ActivityResponse& WithTreatmentId(const char* value) { SetTreatmentId(value); return *this;} /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline const Aws::Map& GetExecutionMetrics() const{ return m_executionMetrics; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline bool ExecutionMetricsHasBeenSet() const { return m_executionMetricsHasBeenSet; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline void SetExecutionMetrics(const Aws::Map& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics = value; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline void SetExecutionMetrics(Aws::Map&& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics = std::move(value); } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& WithExecutionMetrics(const Aws::Map& value) { SetExecutionMetrics(value); return *this;} /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& WithExecutionMetrics(Aws::Map&& value) { SetExecutionMetrics(std::move(value)); return *this;} /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(const Aws::String& key, const Aws::String& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(key, value); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(Aws::String&& key, const Aws::String& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(std::move(key), value); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(const Aws::String& key, Aws::String&& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(key, std::move(value)); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(Aws::String&& key, Aws::String&& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(std::move(key), std::move(value)); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(const char* key, Aws::String&& value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(key, std::move(value)); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(Aws::String&& key, const char* value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(std::move(key), value); return *this; } /** *

A JSON object that contains metrics relating to the campaign execution for * this campaign activity. For information about the structure and contents of the * results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline ActivityResponse& AddExecutionMetrics(const char* key, const char* value) { m_executionMetricsHasBeenSet = true; m_executionMetrics.emplace(key, value); return *this; } private: Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; Aws::String m_campaignId; bool m_campaignIdHasBeenSet = false; Aws::String m_end; bool m_endHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_result; bool m_resultHasBeenSet = false; Aws::String m_scheduledStart; bool m_scheduledStartHasBeenSet = false; Aws::String m_start; bool m_startHasBeenSet = false; Aws::String m_state; bool m_stateHasBeenSet = false; int m_successfulEndpointCount; bool m_successfulEndpointCountHasBeenSet = false; int m_timezonesCompletedCount; bool m_timezonesCompletedCountHasBeenSet = false; int m_timezonesTotalCount; bool m_timezonesTotalCountHasBeenSet = false; int m_totalEndpointCount; bool m_totalEndpointCountHasBeenSet = false; Aws::String m_treatmentId; bool m_treatmentIdHasBeenSet = false; Aws::Map m_executionMetrics; bool m_executionMetricsHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws