Class TreatmentResource

    • Method Detail

      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)