Class TreatmentResource

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

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See Also:

  • Method Details

    • customDeliveryConfiguration

      public final CustomDeliveryConfiguration customDeliveryConfiguration()

      The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

      Returns:
      The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

    • id

      public final String id()

      The unique identifier for the treatment.

      Returns:
      The unique identifier for the treatment.

    • messageConfiguration

      public final MessageConfiguration messageConfiguration()

      The message configuration settings for the treatment.

      Returns:
      The message configuration settings for the treatment.

    • schedule

      public final Schedule schedule()

      The schedule settings for the treatment.

      Returns:
      The schedule settings for the treatment.

    • sizePercent

      public final Integer sizePercent()

      The allocated percentage of users (segment members) that the treatment is sent to.

      Returns:
      The allocated percentage of users (segment members) that the treatment is sent to.

    • state

      public final CampaignState state()

      The current status of the treatment.

      Returns:
      The current status of the treatment.

    • templateConfiguration

      public final TemplateConfiguration templateConfiguration()

      The message template to use for the treatment.

      Returns:
      The message template to use for the treatment.

    • treatmentDescription

      public final String treatmentDescription()

      The custom description of the treatment.

      Returns:
      The custom description of the treatment.

    • treatmentName

      public final String treatmentName()

      The custom name of the treatment.

      Returns:
      The custom name of the treatment.

    • toBuilder

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

    • builder

      public static TreatmentResource.Builder builder()

    • serializableBuilderClass

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