AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest Class Reference

#include <GetJourneyDateRangeKpiRequest.h>

+ Inheritance diagram for Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest:

Public Member Functions

 GetJourneyDateRangeKpiRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetApplicationId () const
 
bool ApplicationIdHasBeenSet () const
 
void SetApplicationId (const Aws::String &value)
 
void SetApplicationId (Aws::String &&value)
 
void SetApplicationId (const char *value)
 
GetJourneyDateRangeKpiRequestWithApplicationId (const Aws::String &value)
 
GetJourneyDateRangeKpiRequestWithApplicationId (Aws::String &&value)
 
GetJourneyDateRangeKpiRequestWithApplicationId (const char *value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
GetJourneyDateRangeKpiRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetJourneyDateRangeKpiRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetJourneyId () const
 
bool JourneyIdHasBeenSet () const
 
void SetJourneyId (const Aws::String &value)
 
void SetJourneyId (Aws::String &&value)
 
void SetJourneyId (const char *value)
 
GetJourneyDateRangeKpiRequestWithJourneyId (const Aws::String &value)
 
GetJourneyDateRangeKpiRequestWithJourneyId (Aws::String &&value)
 
GetJourneyDateRangeKpiRequestWithJourneyId (const char *value)
 
const Aws::StringGetKpiName () const
 
bool KpiNameHasBeenSet () const
 
void SetKpiName (const Aws::String &value)
 
void SetKpiName (Aws::String &&value)
 
void SetKpiName (const char *value)
 
GetJourneyDateRangeKpiRequestWithKpiName (const Aws::String &value)
 
GetJourneyDateRangeKpiRequestWithKpiName (Aws::String &&value)
 
GetJourneyDateRangeKpiRequestWithKpiName (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetJourneyDateRangeKpiRequestWithNextToken (const Aws::String &value)
 
GetJourneyDateRangeKpiRequestWithNextToken (Aws::String &&value)
 
GetJourneyDateRangeKpiRequestWithNextToken (const char *value)
 
const Aws::StringGetPageSize () const
 
bool PageSizeHasBeenSet () const
 
void SetPageSize (const Aws::String &value)
 
void SetPageSize (Aws::String &&value)
 
void SetPageSize (const char *value)
 
GetJourneyDateRangeKpiRequestWithPageSize (const Aws::String &value)
 
GetJourneyDateRangeKpiRequestWithPageSize (Aws::String &&value)
 
GetJourneyDateRangeKpiRequestWithPageSize (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetJourneyDateRangeKpiRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetJourneyDateRangeKpiRequestWithStartTime (Aws::Utils::DateTime &&value)
 
- Public Member Functions inherited from Aws::Pinpoint::PinpointRequest
virtual ~PinpointRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Pinpoint::PinpointRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file GetJourneyDateRangeKpiRequest.h.

Constructor & Destructor Documentation

◆ GetJourneyDateRangeKpiRequest()

Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetJourneyDateRangeKpiRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ApplicationIdHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::ApplicationIdHasBeenSet ( ) const
inline

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

Definition at line 52 of file GetJourneyDateRangeKpiRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::EndTimeHasBeenSet ( ) const
inline

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.

Definition at line 105 of file GetJourneyDateRangeKpiRequest.h.

◆ GetApplicationId()

const Aws::String& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetApplicationId ( ) const
inline

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

Definition at line 46 of file GetJourneyDateRangeKpiRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetEndTime ( ) const
inline

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.

Definition at line 97 of file GetJourneyDateRangeKpiRequest.h.

◆ GetJourneyId()

const Aws::String& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetJourneyId ( ) const
inline

The unique identifier for the journey.

Definition at line 143 of file GetJourneyDateRangeKpiRequest.h.

◆ GetKpiName()

const Aws::String& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetKpiName ( ) const
inline

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.

Definition at line 190 of file GetJourneyDateRangeKpiRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetNextToken ( ) const
inline

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.

Definition at line 275 of file GetJourneyDateRangeKpiRequest.h.

◆ GetPageSize()

const Aws::String& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetPageSize ( ) const
inline

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.

Definition at line 332 of file GetJourneyDateRangeKpiRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetJourneyDateRangeKpiRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::GetStartTime ( ) const
inline

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.

Definition at line 391 of file GetJourneyDateRangeKpiRequest.h.

◆ JourneyIdHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::JourneyIdHasBeenSet ( ) const
inline

The unique identifier for the journey.

Definition at line 148 of file GetJourneyDateRangeKpiRequest.h.

◆ KpiNameHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::KpiNameHasBeenSet ( ) const
inline

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.

Definition at line 201 of file GetJourneyDateRangeKpiRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 282 of file GetJourneyDateRangeKpiRequest.h.

◆ PageSizeHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::PageSizeHasBeenSet ( ) const
inline

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.

Definition at line 339 of file GetJourneyDateRangeKpiRequest.h.

◆ SerializePayload()

Aws::String Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplicationId() [1/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetApplicationId ( const Aws::String value)
inline

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

Definition at line 58 of file GetJourneyDateRangeKpiRequest.h.

◆ SetApplicationId() [2/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetApplicationId ( Aws::String &&  value)
inline

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

Definition at line 64 of file GetJourneyDateRangeKpiRequest.h.

◆ SetApplicationId() [3/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetApplicationId ( const char *  value)
inline

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

Definition at line 70 of file GetJourneyDateRangeKpiRequest.h.

◆ SetEndTime() [1/2]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 113 of file GetJourneyDateRangeKpiRequest.h.

◆ SetEndTime() [2/2]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 121 of file GetJourneyDateRangeKpiRequest.h.

◆ SetJourneyId() [1/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetJourneyId ( const Aws::String value)
inline

The unique identifier for the journey.

Definition at line 153 of file GetJourneyDateRangeKpiRequest.h.

◆ SetJourneyId() [2/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetJourneyId ( Aws::String &&  value)
inline

The unique identifier for the journey.

Definition at line 158 of file GetJourneyDateRangeKpiRequest.h.

◆ SetJourneyId() [3/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetJourneyId ( const char *  value)
inline

The unique identifier for the journey.

Definition at line 163 of file GetJourneyDateRangeKpiRequest.h.

◆ SetKpiName() [1/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetKpiName ( const Aws::String value)
inline

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.

Definition at line 212 of file GetJourneyDateRangeKpiRequest.h.

◆ SetKpiName() [2/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetKpiName ( Aws::String &&  value)
inline

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.

Definition at line 223 of file GetJourneyDateRangeKpiRequest.h.

◆ SetKpiName() [3/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetKpiName ( const char *  value)
inline

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.

Definition at line 234 of file GetJourneyDateRangeKpiRequest.h.

◆ SetNextToken() [1/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 289 of file GetJourneyDateRangeKpiRequest.h.

◆ SetNextToken() [2/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 296 of file GetJourneyDateRangeKpiRequest.h.

◆ SetNextToken() [3/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 303 of file GetJourneyDateRangeKpiRequest.h.

◆ SetPageSize() [1/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetPageSize ( const Aws::String value)
inline

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.

Definition at line 346 of file GetJourneyDateRangeKpiRequest.h.

◆ SetPageSize() [2/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetPageSize ( Aws::String &&  value)
inline

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.

Definition at line 353 of file GetJourneyDateRangeKpiRequest.h.

◆ SetPageSize() [3/3]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetPageSize ( const char *  value)
inline

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.

Definition at line 360 of file GetJourneyDateRangeKpiRequest.h.

◆ SetStartTime() [1/2]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 409 of file GetJourneyDateRangeKpiRequest.h.

◆ SetStartTime() [2/2]

void Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 418 of file GetJourneyDateRangeKpiRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::StartTimeHasBeenSet ( ) const
inline

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.

Definition at line 400 of file GetJourneyDateRangeKpiRequest.h.

◆ WithApplicationId() [1/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithApplicationId ( const Aws::String value)
inline

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

Definition at line 76 of file GetJourneyDateRangeKpiRequest.h.

◆ WithApplicationId() [2/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithApplicationId ( Aws::String &&  value)
inline

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

Definition at line 82 of file GetJourneyDateRangeKpiRequest.h.

◆ WithApplicationId() [3/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithApplicationId ( const char *  value)
inline

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

Definition at line 88 of file GetJourneyDateRangeKpiRequest.h.

◆ WithEndTime() [1/2]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 129 of file GetJourneyDateRangeKpiRequest.h.

◆ WithEndTime() [2/2]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 137 of file GetJourneyDateRangeKpiRequest.h.

◆ WithJourneyId() [1/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithJourneyId ( const Aws::String value)
inline

The unique identifier for the journey.

Definition at line 168 of file GetJourneyDateRangeKpiRequest.h.

◆ WithJourneyId() [2/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithJourneyId ( Aws::String &&  value)
inline

The unique identifier for the journey.

Definition at line 173 of file GetJourneyDateRangeKpiRequest.h.

◆ WithJourneyId() [3/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithJourneyId ( const char *  value)
inline

The unique identifier for the journey.

Definition at line 178 of file GetJourneyDateRangeKpiRequest.h.

◆ WithKpiName() [1/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithKpiName ( const Aws::String value)
inline

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.

Definition at line 245 of file GetJourneyDateRangeKpiRequest.h.

◆ WithKpiName() [2/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithKpiName ( Aws::String &&  value)
inline

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.

Definition at line 256 of file GetJourneyDateRangeKpiRequest.h.

◆ WithKpiName() [3/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithKpiName ( const char *  value)
inline

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.

Definition at line 267 of file GetJourneyDateRangeKpiRequest.h.

◆ WithNextToken() [1/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 310 of file GetJourneyDateRangeKpiRequest.h.

◆ WithNextToken() [2/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 317 of file GetJourneyDateRangeKpiRequest.h.

◆ WithNextToken() [3/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 324 of file GetJourneyDateRangeKpiRequest.h.

◆ WithPageSize() [1/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithPageSize ( const Aws::String value)
inline

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.

Definition at line 367 of file GetJourneyDateRangeKpiRequest.h.

◆ WithPageSize() [2/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithPageSize ( Aws::String &&  value)
inline

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.

Definition at line 374 of file GetJourneyDateRangeKpiRequest.h.

◆ WithPageSize() [3/3]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithPageSize ( const char *  value)
inline

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.

Definition at line 381 of file GetJourneyDateRangeKpiRequest.h.

◆ WithStartTime() [1/2]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 427 of file GetJourneyDateRangeKpiRequest.h.

◆ WithStartTime() [2/2]

GetJourneyDateRangeKpiRequest& Aws::Pinpoint::Model::GetJourneyDateRangeKpiRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 436 of file GetJourneyDateRangeKpiRequest.h.


The documentation for this class was generated from the following file: