Class MultiConditionalSplitActivity

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

Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

See Also:

  • Method Details

    • hasBranches

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

    • branches

      public final List<MultiConditionalBranch> branches()

      The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

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

      Returns:
      The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

    • defaultActivity

      public final String defaultActivity()

      The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

      Returns:
      The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

    • evaluationWaitTime

      public final WaitTime evaluationWaitTime()

      The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

      Returns:
      The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

    • toBuilder

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

    • builder

      public static MultiConditionalSplitActivity.Builder builder()

    • serializableBuilderClass

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