com.amazonaws.services.pinpoint.model

Class GetCampaignDateRangeKpiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpoint.model.GetCampaignDateRangeKpiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCampaignDateRangeKpiRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetCampaignDateRangeKpiRequest()

Method Summary

Modifier and Type	Method and Description
GetCampaignDateRangeKpiRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The unique identifier for the application.
String	getCampaignId() The unique identifier for the campaign.
Date	getEndTime() The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.
String	getKpiName() The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
String	getNextToken() The string that specifies which page of results to return in a paginated response.
String	getPageSize() The maximum number of items to include in each page of a paginated response.
Date	getStartTime() The first date and time to retrieve data for, as part of an inclusive date range that filters the query results.
int	hashCode()
void	setApplicationId(String applicationId) The unique identifier for the application.
void	setCampaignId(String campaignId) The unique identifier for the campaign.
void	setEndTime(Date endTime) The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.
void	setKpiName(String kpiName) The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
void	setNextToken(String nextToken) The string that specifies which page of results to return in a paginated response.
void	setPageSize(String pageSize) The maximum number of items to include in each page of a paginated response.
void	setStartTime(Date startTime) The first date and time to retrieve data for, as part of an inclusive date range that filters the query results.
String	toString() Returns a string representation of this object.
GetCampaignDateRangeKpiRequest	withApplicationId(String applicationId) The unique identifier for the application.
GetCampaignDateRangeKpiRequest	withCampaignId(String campaignId) The unique identifier for the campaign.
GetCampaignDateRangeKpiRequest	withEndTime(Date endTime) The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.
GetCampaignDateRangeKpiRequest	withKpiName(String kpiName) The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
GetCampaignDateRangeKpiRequest	withNextToken(String nextToken) The string that specifies which page of results to return in a paginated response.
GetCampaignDateRangeKpiRequest	withPageSize(String pageSize) The maximum number of items to include in each page of a paginated response.
GetCampaignDateRangeKpiRequest	withStartTime(Date startTime) The first date and time to retrieve data for, as part of an inclusive date range that filters the query results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetCampaignDateRangeKpiRequest

public GetCampaignDateRangeKpiRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

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

Parameters:

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

getApplicationId

public String getApplicationId()

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

Returns:

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

withApplicationId

public GetCampaignDateRangeKpiRequest withApplicationId(String applicationId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCampaignId

public void setCampaignId(String campaignId)

The unique identifier for the campaign.

Parameters:

campaignId - The unique identifier for the campaign.

getCampaignId

public String getCampaignId()

The unique identifier for the campaign.

Returns:

The unique identifier for the campaign.

withCampaignId

public GetCampaignDateRangeKpiRequest withCampaignId(String campaignId)

The unique identifier for the campaign.

Parameters:

campaignId - The unique identifier for the campaign.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndTime

public void setEndTime(Date 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.

Parameters:

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.

getEndTime

public Date getEndTime()

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.

Returns:

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.

withEndTime

public GetCampaignDateRangeKpiRequest withEndTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKpiName

public void setKpiName(String 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.

Parameters:

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.

getKpiName

public String getKpiName()

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.

Returns:

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.

withKpiName

public GetCampaignDateRangeKpiRequest withKpiName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String 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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

Returns:

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.

withNextToken

public GetCampaignDateRangeKpiRequest withNextToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPageSize

public void setPageSize(String 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.

Parameters:

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.

getPageSize

public String getPageSize()

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.

Returns:

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.

withPageSize

public GetCampaignDateRangeKpiRequest withPageSize(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date 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.

Parameters:

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.

getStartTime

public Date getStartTime()

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.

Returns:

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.

withStartTime

public GetCampaignDateRangeKpiRequest withStartTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetCampaignDateRangeKpiRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()