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

Interface PushMessageActivity.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PushMessageActivity.Builder,PushMessageActivity>, SdkBuilder<PushMessageActivity.Builder,PushMessageActivity>, SdkPojo
Enclosing class:
PushMessageActivity
public static interface PushMessageActivity.Builder extends SdkPojo, CopyableBuilder<PushMessageActivity.Builder,PushMessageActivity>

  • Method Details

    • messageConfig

      PushMessageActivity.Builder messageConfig(JourneyPushMessage messageConfig)

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

      Parameters:
      messageConfig - Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageConfig

      default PushMessageActivity.Builder messageConfig(Consumer<JourneyPushMessage.Builder> messageConfig)

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

      This is a convenience method that creates an instance of the JourneyPushMessage.Builder avoiding the need to create one manually via JourneyPushMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageConfig(JourneyPushMessage).

      Parameters:
      messageConfig - a consumer that will call methods on JourneyPushMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextActivity

      PushMessageActivity.Builder nextActivity(String nextActivity)

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

      Parameters:
      nextActivity - The unique identifier for the next activity to perform, after the message is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateName

      PushMessageActivity.Builder templateName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • templateVersion

      PushMessageActivity.Builder templateVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.