software.amazon.awssdk.services.pinpoint.model

Class GetApplicationDateRangeKpiRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pinpoint.model.PinpointRequest

software.amazon.awssdk.services.pinpoint.model.GetApplicationDateRangeKpiRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetApplicationDateRangeKpiRequest.Builder,GetApplicationDateRangeKpiRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetApplicationDateRangeKpiRequest
extends PinpointRequest
implements ToCopyableBuilder<GetApplicationDateRangeKpiRequest.Builder,GetApplicationDateRangeKpiRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetApplicationDateRangeKpiRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The unique identifier for the application.
static GetApplicationDateRangeKpiRequest.Builder	builder()
Instant	endTime() The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kpiName() The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
String	nextToken() The string that specifies which page of results to return in a paginated response.
String	pageSize() The maximum number of items to include in each page of a paginated response.
List<SdkField<?>>	sdkFields()
static Class<? extends GetApplicationDateRangeKpiRequest.Builder>	serializableBuilderClass()
Instant	startTime() The first date and time to retrieve data for, as part of an inclusive date range that filters the query results.
GetApplicationDateRangeKpiRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationId

public String applicationId()

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.

endTime

public Instant 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:

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.

kpiName

public 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.

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.

nextToken

public 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.

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.

pageSize

public 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.

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.

startTime

public Instant 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:

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.

toBuilder

public GetApplicationDateRangeKpiRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetApplicationDateRangeKpiRequest.Builder,GetApplicationDateRangeKpiRequest>

Specified by:

toBuilder in class PinpointRequest

builder

public static GetApplicationDateRangeKpiRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetApplicationDateRangeKpiRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo