software.amazon.awssdk.services.pinpoint.model

Class JourneyExecutionMetricsResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.JourneyExecutionMetricsResponse

All Implemented Interfaces:

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

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

Provides the results of a query that retrieved the data for a standard execution 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 and Description
static interface	JourneyExecutionMetricsResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The unique identifier for the application that the metric applies to.
static JourneyExecutionMetricsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	journeyId() The unique identifier for the journey that the metric applies to.
String	lastEvaluatedTime() The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
Map<String,String>	metrics() A JSON object that contains the results of the query.
List<SdkField<?>>	sdkFields()
static Class<? extends JourneyExecutionMetricsResponse.Builder>	serializableBuilderClass()
JourneyExecutionMetricsResponse.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 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.

journeyId

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

lastEvaluatedTime

public String lastEvaluatedTime()

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

Returns:

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

hasMetrics

public boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public Map<String,String> metrics()

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

toBuilder

public JourneyExecutionMetricsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JourneyExecutionMetricsResponse.Builder,JourneyExecutionMetricsResponse>

builder

public static JourneyExecutionMetricsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo