Class ActivityResponse

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

Provides information about an activity that was performed by a campaign.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

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

      Returns:
      The unique identifier for the application that the campaign applies to.

    • campaignId

      public final String campaignId()

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

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

    • end

      public final String end()

      The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

      Returns:
      The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

    • id

      public final String id()

      The unique identifier for the activity.

      Returns:
      The unique identifier for the activity.

    • result

      public final String result()

      Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

      Returns:
      Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

    • scheduledStart

      public final String scheduledStart()

      The scheduled start time, in ISO 8601 format, for the activity.

      Returns:
      The scheduled start time, in ISO 8601 format, for the activity.

    • start

      public final String start()

      The actual start time, in ISO 8601 format, of the activity.

      Returns:
      The actual start time, in ISO 8601 format, of the activity.

    • state

      public final String state()

      The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

      Returns:
      The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

    • successfulEndpointCount

      public final Integer successfulEndpointCount()

      The total number of endpoints that the campaign successfully delivered messages to.

      Returns:
      The total number of endpoints that the campaign successfully delivered messages to.

    • timezonesCompletedCount

      public final Integer timezonesCompletedCount()

      The total number of time zones that were completed.

      Returns:
      The total number of time zones that were completed.

    • timezonesTotalCount

      public final Integer timezonesTotalCount()

      The total number of unique time zones that are in the segment for the campaign.

      Returns:
      The total number of unique time zones that are in the segment for the campaign.

    • totalEndpointCount

      public final Integer totalEndpointCount()

      The total number of endpoints that the campaign attempted to deliver messages to.

      Returns:
      The total number of endpoints that the campaign attempted to deliver messages to.

    • treatmentId

      public final String treatmentId()

      The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      Returns:
      The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    • hasExecutionMetrics

      public final boolean hasExecutionMetrics()
      For responses, this returns true if the service returned a value for the ExecutionMetrics 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.

    • executionMetrics

      public final Map<String,String> executionMetrics()

      A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, 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 hasExecutionMetrics() method.

      Returns:
      A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

    • toBuilder

      public ActivityResponse.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<ActivityResponse.Builder,ActivityResponse>
      Returns:
      a builder for type T

    • builder

      public static ActivityResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ActivityResponse.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.