Class PushMessageActivity

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

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

See Also:

  • Method Details

    • messageConfig

      public final JourneyPushMessage messageConfig()

      Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

      Returns:
      Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

    • nextActivity

      public final String nextActivity()

      The unique identifier for the next activity to perform, after the message is sent.

      Returns:
      The unique identifier for the next activity to perform, after the message is sent.

    • templateName

      public final String templateName()

      The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

      Returns:
      The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

    • templateVersion

      public final String templateVersion()

      The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

      If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      Returns:
      The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

      If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    • toBuilder

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

    • builder

      public static PushMessageActivity.Builder builder()

    • serializableBuilderClass

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