Package software.amazon.awssdk.services.pinpoint.model

Class JourneyDateRangeKpiResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.JourneyDateRangeKpiResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JourneyDateRangeKpiResponse.Builder,JourneyDateRangeKpiResponse>

@Generated("software.amazon.awssdk:codegen")
public final class JourneyDateRangeKpiResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JourneyDateRangeKpiResponse.Builder,JourneyDateRangeKpiResponse>

Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JourneyDateRangeKpiResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier for the application that the metric applies to.
static JourneyDateRangeKpiResponse.Builder	builder()
Instant	endTime()	The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	journeyId()	The unique identifier for the journey that the metric applies to.
String	kpiName()	The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.
BaseKpiResult	kpiResult()	An array of objects that contains the results of the query.
String	nextToken()	The string to use in a subsequent request to get the next page of results in a paginated response.
List<SdkField<?>>	sdkFields()
static Class<? extends JourneyDateRangeKpiResponse.Builder>	serializableBuilderClass()
Instant	startTime()	The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
JourneyDateRangeKpiResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 final String applicationId()

The unique identifier for the application that the metric applies to.

Returns:

The unique identifier for the application that the metric applies to.

endTime

public final Instant endTime()

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Returns:

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journeyId

public final String journeyId()

The unique identifier for the journey that the metric applies to.

Returns:

The unique identifier for the journey that the metric applies to.

kpiName

public final String kpiName()

The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved 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. For a list of possible values, see the Amazon Pinpoint Developer Guide.

Returns:

The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved 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. For a list of possible values, see the Amazon Pinpoint Developer Guide.

kpiResult

public final BaseKpiResult kpiResult()

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

Returns:

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

nextToken

public final String nextToken()

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

Returns:

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

startTime

public final Instant startTime()

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Returns:

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

toBuilder

public JourneyDateRangeKpiResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JourneyDateRangeKpiResponse.Builder,JourneyDateRangeKpiResponse>

builder

public static JourneyDateRangeKpiResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo