Class JourneyRunExecutionActivityMetricsResponse

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.JourneyRunExecutionActivityMetricsResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>
@Generated("software.amazon.awssdk:codegen") public final class JourneyRunExecutionActivityMetricsResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>

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

See Also:

  • Method Details

    • activityType

      public final String activityType()

      The type of activity that the metric applies to. Possible values are:

      • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

      • HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

      • MESSAGE – For an email activity, which is an activity that sends an email message to participants.

      • MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

      • RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

      • WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

      Returns:
      The type of activity that the metric applies to. Possible values are:

      • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

      • HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

      • MESSAGE – For an email activity, which is an activity that sends an email message to participants.

      • MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

      • RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

      • WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

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

    • journeyActivityId

      public final String journeyActivityId()

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

      Returns:
      The unique identifier for the activity that the metric applies to.

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

    • lastEvaluatedTime

      public final String lastEvaluatedTime()

      The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.

      Returns:
      The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.

    • hasMetrics

      public final boolean hasMetrics()
      For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metrics

      public final 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 see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

      Returns:
      A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

    • runId

      public final String runId()

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

      Returns:
      The unique identifier for the journey run that the metric applies to.

    • toBuilder

      public JourneyRunExecutionActivityMetricsResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>
      Returns:
      a builder for type T

    • builder

      public static JourneyRunExecutionActivityMetricsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JourneyRunExecutionActivityMetricsResponse.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.