/** * 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 Http { class URI; } //namespace Http namespace Pinpoint { namespace Model { /** */ class GetJourneyDateRangeKpiRequest : public PinpointRequest { public: AWS_PINPOINT_API GetJourneyDateRangeKpiRequest(); // 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 "GetJourneyDateRangeKpi"; } AWS_PINPOINT_API Aws::String SerializePayload() const override; AWS_PINPOINT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The unique identifier for the application. This identifier is displayed as * the Project ID on the Amazon Pinpoint console.

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

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline GetJourneyDateRangeKpiRequest& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

The last date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

*/ inline GetJourneyDateRangeKpiRequest& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The unique identifier for the journey.

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

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline const Aws::String& GetKpiName() const{ return m_kpiName; } /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline GetJourneyDateRangeKpiRequest& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline GetJourneyDateRangeKpiRequest& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} /** *

The name of the metric, also referred to as a key performance indicator * (KPI), to retrieve data for. This value describes the associated metric and * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon * Pinpoint Developer Guide.

*/ inline GetJourneyDateRangeKpiRequest& WithKpiName(const char* value) { SetKpiName(value); return *this;} /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The string that specifies which page of results to return in a paginated * response. This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

The maximum number of items to include in each page of a paginated response. * This parameter is not supported for application, campaign, and journey * metrics.

*/ inline GetJourneyDateRangeKpiRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline GetJourneyDateRangeKpiRequest& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

The first date and time to retrieve data for, as part of an inclusive date * range that filters the query results. This value should be in extended ISO 8601 * format and use Coordinated Universal Time (UTC), for example: * 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be * fewer than 90 days from the current day.

*/ inline GetJourneyDateRangeKpiRequest& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} private: Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; Aws::String m_journeyId; bool m_journeyIdHasBeenSet = false; Aws::String m_kpiName; bool m_kpiNameHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::String m_pageSize; bool m_pageSizeHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws