This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionActivityMetricsResponse.h

501 lines
26 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/pinpoint/Pinpoint_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Pinpoint
{
namespace Model
{
/**
* <p>Provides the results of a query that retrieved the data for a standard
* execution metric that applies to a journey activity, and provides information
* about that query.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionActivityMetricsResponse">AWS
* API Reference</a></p>
*/
class AWS_PINPOINT_API JourneyExecutionActivityMetricsResponse
{
public:
JourneyExecutionActivityMetricsResponse();
JourneyExecutionActivityMetricsResponse(Aws::Utils::Json::JsonView jsonValue);
JourneyExecutionActivityMetricsResponse& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline const Aws::String& GetActivityType() const{ return m_activityType; }
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline bool ActivityTypeHasBeenSet() const { return m_activityTypeHasBeenSet; }
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline void SetActivityType(const Aws::String& value) { m_activityTypeHasBeenSet = true; m_activityType = value; }
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline void SetActivityType(Aws::String&& value) { m_activityTypeHasBeenSet = true; m_activityType = std::move(value); }
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline void SetActivityType(const char* value) { m_activityTypeHasBeenSet = true; m_activityType.assign(value); }
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline JourneyExecutionActivityMetricsResponse& WithActivityType(const Aws::String& value) { SetActivityType(value); return *this;}
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline JourneyExecutionActivityMetricsResponse& WithActivityType(Aws::String&& value) { SetActivityType(std::move(value)); return *this;}
/**
* <p>The type of activity that the metric applies to. Possible values are:</p>
* <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
* that sends participants down one of two paths in a journey.</p></li>
* <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a
* journey for a specified percentage of participants.</p></li> <li><p>MESSAGE -
* For an email activity, which is an activity that sends an email message to
* participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>
*/
inline JourneyExecutionActivityMetricsResponse& WithActivityType(const char* value) { SetActivityType(value); return *this;}
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline const Aws::String& GetApplicationId() const{ return m_applicationId; }
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; }
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; }
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); }
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); }
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;}
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;}
/**
* <p>The unique identifier for the application that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;}
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline const Aws::String& GetJourneyActivityId() const{ return m_journeyActivityId; }
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline bool JourneyActivityIdHasBeenSet() const { return m_journeyActivityIdHasBeenSet; }
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline void SetJourneyActivityId(const Aws::String& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = value; }
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline void SetJourneyActivityId(Aws::String&& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = std::move(value); }
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline void SetJourneyActivityId(const char* value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId.assign(value); }
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyActivityId(const Aws::String& value) { SetJourneyActivityId(value); return *this;}
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyActivityId(Aws::String&& value) { SetJourneyActivityId(std::move(value)); return *this;}
/**
* <p>The unique identifier for the activity that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyActivityId(const char* value) { SetJourneyActivityId(value); return *this;}
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline const Aws::String& GetJourneyId() const{ return m_journeyId; }
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline bool JourneyIdHasBeenSet() const { return m_journeyIdHasBeenSet; }
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline void SetJourneyId(const Aws::String& value) { m_journeyIdHasBeenSet = true; m_journeyId = value; }
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline void SetJourneyId(Aws::String&& value) { m_journeyIdHasBeenSet = true; m_journeyId = std::move(value); }
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline void SetJourneyId(const char* value) { m_journeyIdHasBeenSet = true; m_journeyId.assign(value); }
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyId(const Aws::String& value) { SetJourneyId(value); return *this;}
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyId(Aws::String&& value) { SetJourneyId(std::move(value)); return *this;}
/**
* <p>The unique identifier for the journey that the metric applies to.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithJourneyId(const char* value) { SetJourneyId(value); return *this;}
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline const Aws::String& GetLastEvaluatedTime() const{ return m_lastEvaluatedTime; }
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline bool LastEvaluatedTimeHasBeenSet() const { return m_lastEvaluatedTimeHasBeenSet; }
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline void SetLastEvaluatedTime(const Aws::String& value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime = value; }
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline void SetLastEvaluatedTime(Aws::String&& value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime = std::move(value); }
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline void SetLastEvaluatedTime(const char* value) { m_lastEvaluatedTimeHasBeenSet = true; m_lastEvaluatedTime.assign(value); }
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithLastEvaluatedTime(const Aws::String& value) { SetLastEvaluatedTime(value); return *this;}
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithLastEvaluatedTime(Aws::String&& value) { SetLastEvaluatedTime(std::move(value)); return *this;}
/**
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
* the execution status of the activity and updated the data for the metric.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithLastEvaluatedTime(const char* value) { SetLastEvaluatedTime(value); return *this;}
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline const Aws::Map<Aws::String, Aws::String>& GetMetrics() const{ return m_metrics; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline bool MetricsHasBeenSet() const { return m_metricsHasBeenSet; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline void SetMetrics(const Aws::Map<Aws::String, Aws::String>& value) { m_metricsHasBeenSet = true; m_metrics = value; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline void SetMetrics(Aws::Map<Aws::String, Aws::String>&& value) { m_metricsHasBeenSet = true; m_metrics = std::move(value); }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithMetrics(const Aws::Map<Aws::String, Aws::String>& value) { SetMetrics(value); return *this;}
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& WithMetrics(Aws::Map<Aws::String, Aws::String>&& value) { SetMetrics(std::move(value)); return *this;}
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), std::move(value)); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(const char* key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; }
/**
* <p>A JSON object that contains the results of the query. The results vary
* depending on the type of activity (ActivityType). For information about the
* structure and contents of the results, see the <a
* href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
* Pinpoint Developer Guide</a>.</p>
*/
inline JourneyExecutionActivityMetricsResponse& AddMetrics(const char* key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; }
private:
Aws::String m_activityType;
bool m_activityTypeHasBeenSet;
Aws::String m_applicationId;
bool m_applicationIdHasBeenSet;
Aws::String m_journeyActivityId;
bool m_journeyActivityIdHasBeenSet;
Aws::String m_journeyId;
bool m_journeyIdHasBeenSet;
Aws::String m_lastEvaluatedTime;
bool m_lastEvaluatedTimeHasBeenSet;
Aws::Map<Aws::String, Aws::String> m_metrics;
bool m_metricsHasBeenSet;
};
} // namespace Model
} // namespace Pinpoint
} // namespace Aws