Class InAppMessageCampaign

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.InAppMessageCampaign
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InAppMessageCampaign.Builder,InAppMessageCampaign>

@Generated("software.amazon.awssdk:codegen") public final class InAppMessageCampaign extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InAppMessageCampaign.Builder,InAppMessageCampaign>

Targeted in-app message campaign.

See Also:
  • Method Details

    • campaignId

      public final String campaignId()

      Campaign id of the corresponding campaign.

      Returns:
      Campaign id of the corresponding campaign.
    • dailyCap

      public final Integer dailyCap()

      Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

      Returns:
      Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
    • inAppMessage

      public final InAppMessage inAppMessage()

      In-app message content with all fields required for rendering an in-app message.

      Returns:
      In-app message content with all fields required for rendering an in-app message.
    • priority

      public final Integer priority()

      Priority of the in-app message.

      Returns:
      Priority of the in-app message.
    • schedule

      public final InAppCampaignSchedule schedule()

      Schedule of the campaign.

      Returns:
      Schedule of the campaign.
    • sessionCap

      public final Integer sessionCap()

      Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

      Returns:
      Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
    • totalCap

      public final Integer totalCap()

      Total cap which controls the number of times an in-app message can be shown to the endpoint.

      Returns:
      Total cap which controls the number of times an in-app message can be shown to the endpoint.
    • treatmentId

      public final String treatmentId()

      Treatment id of the campaign.

      Returns:
      Treatment id of the campaign.
    • toBuilder

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

      public static InAppMessageCampaign.Builder builder()
    • serializableBuilderClass

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