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

Class CustomMessageActivity

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

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

See Also:

  • Method Details

    • deliveryUri

      public final String deliveryUri()

      The destination to send the campaign or treatment to. This value can be one of the following:

      • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

      • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

      Returns:
      The destination to send the campaign or treatment to. This value can be one of the following:

      • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

      • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

    • endpointTypes

      public final List<EndpointTypesElement> endpointTypes()

      The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

      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 hasEndpointTypes() method.

      Returns:
      The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    • hasEndpointTypes

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

    • endpointTypesAsStrings

      public final List<String> endpointTypesAsStrings()

      The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

      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 hasEndpointTypes() method.

      Returns:
      The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    • messageConfig

      public final JourneyCustomMessage messageConfig()

      Specifies the message data included in a custom channel message that's sent to participants in a journey.

      Returns:
      Specifies the message data included in a custom channel message that's sent to participants in a journey.

    • nextActivity

      public final String nextActivity()

      The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

      Returns:
      The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

    • templateName

      public final String templateName()

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

      Returns:
      The name of the custom message 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 message 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 message 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 CustomMessageActivity.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<CustomMessageActivity.Builder,CustomMessageActivity>
      Returns:
      a builder for type T

    • builder

      public static CustomMessageActivity.Builder builder()

    • serializableBuilderClass

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