/** * 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 the results of a query that retrieved the data for a standard * execution metric that applies to a journey activity for a particular journey * run, and provides information about that query.

See Also:

AWS * API Reference

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

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline const Aws::String& GetActivityType() const{ return m_activityType; } /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline bool ActivityTypeHasBeenSet() const { return m_activityTypeHasBeenSet; } /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline void SetActivityType(const Aws::String& value) { m_activityTypeHasBeenSet = true; m_activityType = value; } /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline void SetActivityType(Aws::String&& value) { m_activityTypeHasBeenSet = true; m_activityType = std::move(value); } /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline void SetActivityType(const char* value) { m_activityTypeHasBeenSet = true; m_activityType.assign(value); } /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithActivityType(const Aws::String& value) { SetActivityType(value); return *this;} /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithActivityType(Aws::String&& value) { SetActivityType(std::move(value)); return *this;} /** *

The type of activity that the metric applies to. Possible values are:

*
  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity * that sends participants down one of two paths in a journey.

  • *
  • HOLDOUT – For a holdout activity, which is an activity that stops a * journey for a specified percentage of participants.

  • MESSAGE – * For an email activity, which is an activity that sends an email message to * participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split * activity, which is an activity that sends participants down one of as many as * five paths in a journey.

  • RANDOM_SPLIT – For a random split * activity, which is an activity that sends specified percentages of participants * down one of as many as five paths in a journey.

  • WAIT – For a * wait activity, which is an activity that waits for a certain amount of time or * until a specific date and time before moving participants to the next activity * in a journey.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithActivityType(const char* value) { SetActivityType(value); return *this;} /** *

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

*/ inline const Aws::String& GetJourneyActivityId() const{ return m_journeyActivityId; } /** *

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

*/ inline bool JourneyActivityIdHasBeenSet() const { return m_journeyActivityIdHasBeenSet; } /** *

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

*/ inline void SetJourneyActivityId(const Aws::String& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = value; } /** *

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

*/ inline void SetJourneyActivityId(Aws::String&& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = std::move(value); } /** *

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

*/ inline void SetJourneyActivityId(const char* value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId.assign(value); } /** *

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

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyActivityId(const Aws::String& value) { SetJourneyActivityId(value); return *this;} /** *

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

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyActivityId(Aws::String&& value) { SetJourneyActivityId(std::move(value)); return *this;} /** *

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

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyActivityId(const char* value) { SetJourneyActivityId(value); return *this;} /** *

The unique identifier for the journey that the metric applies to.

*/ inline const Aws::String& GetJourneyId() const{ return m_journeyId; } /** *

The unique identifier for the journey that the metric applies to.

*/ inline bool JourneyIdHasBeenSet() const { return m_journeyIdHasBeenSet; } /** *

The unique identifier for the journey that the metric applies to.

*/ inline void SetJourneyId(const Aws::String& value) { m_journeyIdHasBeenSet = true; m_journeyId = value; } /** *

The unique identifier for the journey that the metric applies to.

*/ inline void SetJourneyId(Aws::String&& value) { m_journeyIdHasBeenSet = true; m_journeyId = std::move(value); } /** *

The unique identifier for the journey that the metric applies to.

*/ inline void SetJourneyId(const char* value) { m_journeyIdHasBeenSet = true; m_journeyId.assign(value); } /** *

The unique identifier for the journey that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyId(const Aws::String& value) { SetJourneyId(value); return *this;} /** *

The unique identifier for the journey that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyId(Aws::String&& value) { SetJourneyId(std::move(value)); return *this;} /** *

The unique identifier for the journey that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithJourneyId(const char* value) { SetJourneyId(value); return *this;} /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline const Aws::String& GetLastEvaluatedTime() const{ return m_lastEvaluatedTime; } /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline bool LastEvaluatedTimeHasBeenSet() const { return m_lastEvaluatedTimeHasBeenSet; } /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline void SetLastEvaluatedTime(const Aws::String& value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime = value; } /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline void SetLastEvaluatedTime(Aws::String&& value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime = std::move(value); } /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline void SetLastEvaluatedTime(const char* value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime.assign(value); } /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithLastEvaluatedTime(const Aws::String& value) { SetLastEvaluatedTime(value); return *this;} /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithLastEvaluatedTime(Aws::String&& value) { SetLastEvaluatedTime(std::move(value)); return *this;} /** *

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated * the execution status of the activity for this journey run and updated the data * for the metric.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithLastEvaluatedTime(const char* value) { SetLastEvaluatedTime(value); return *this;} /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline const Aws::Map& GetMetrics() const{ return m_metrics; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline bool MetricsHasBeenSet() const { return m_metricsHasBeenSet; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline void SetMetrics(const Aws::Map& value) { m_metricsHasBeenSet = true; m_metrics = value; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline void SetMetrics(Aws::Map&& value) { m_metricsHasBeenSet = true; m_metrics = std::move(value); } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithMetrics(const Aws::Map& value) { SetMetrics(value); return *this;} /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithMetrics(Aws::Map&& value) { SetMetrics(std::move(value)); return *this;} /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), std::move(value)); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(const char* key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } /** *

A JSON object that contains the results of the query. For information about * the structure and contents of the results, see see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer * Guide.

*/ inline JourneyRunExecutionActivityMetricsResponse& AddMetrics(const char* key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline const Aws::String& GetRunId() const{ return m_runId; } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline bool RunIdHasBeenSet() const { return m_runIdHasBeenSet; } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline void SetRunId(const Aws::String& value) { m_runIdHasBeenSet = true; m_runId = value; } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline void SetRunId(Aws::String&& value) { m_runIdHasBeenSet = true; m_runId = std::move(value); } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline void SetRunId(const char* value) { m_runIdHasBeenSet = true; m_runId.assign(value); } /** *

The unique identifier for the journey run that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithRunId(const Aws::String& value) { SetRunId(value); return *this;} /** *

The unique identifier for the journey run that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithRunId(Aws::String&& value) { SetRunId(std::move(value)); return *this;} /** *

The unique identifier for the journey run that the metric applies to.

*/ inline JourneyRunExecutionActivityMetricsResponse& WithRunId(const char* value) { SetRunId(value); return *this;} private: Aws::String m_activityType; bool m_activityTypeHasBeenSet = false; Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; Aws::String m_journeyActivityId; bool m_journeyActivityIdHasBeenSet = false; Aws::String m_journeyId; bool m_journeyIdHasBeenSet = false; Aws::String m_lastEvaluatedTime; bool m_lastEvaluatedTimeHasBeenSet = false; Aws::Map m_metrics; bool m_metricsHasBeenSet = false; Aws::String m_runId; bool m_runIdHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws