Class WriteCampaignRequest

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

Specifies the configuration and other settings for a campaign.

See Also:

  • Method Details

    • hasAdditionalTreatments

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

    • additionalTreatments

      public final List<WriteTreatmentResource> additionalTreatments()

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

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

      Returns:
      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

    • customDeliveryConfiguration

      public final CustomDeliveryConfiguration customDeliveryConfiguration()

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

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

    • description

      public final String description()

      A custom description of the campaign.

      Returns:
      A custom description of the campaign.

    • holdoutPercent

      public final Integer holdoutPercent()

      The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

      Returns:
      The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    • hook

      public final CampaignHook hook()

      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      Returns:
      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

    • isPaused

      public final Boolean isPaused()

      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

      Returns:
      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

    • limits

      public final CampaignLimits limits()

      The messaging limits for the campaign.

      Returns:
      The messaging limits for the campaign.

    • messageConfiguration

      public final MessageConfiguration messageConfiguration()

      The message configuration settings for the campaign.

      Returns:
      The message configuration settings for the campaign.

    • name

      public final String name()

      A custom name for the campaign.

      Returns:
      A custom name for the campaign.

    • schedule

      public final Schedule schedule()

      The schedule settings for the campaign.

      Returns:
      The schedule settings for the campaign.

    • segmentId

      public final String segmentId()

      The unique identifier for the segment to associate with the campaign.

      Returns:
      The unique identifier for the segment to associate with the campaign.

    • segmentVersion

      public final Integer segmentVersion()

      The version of the segment to associate with the campaign.

      Returns:
      The version of the segment to associate with the campaign.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

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

      Returns:
      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

    • templateConfiguration

      public final TemplateConfiguration templateConfiguration()

      The message template to use for the campaign.

      Returns:
      The message template to use for the campaign.

    • treatmentDescription

      public final String treatmentDescription()

      A custom description of the default treatment for the campaign.

      Returns:
      A custom description of the default treatment for the campaign.

    • treatmentName

      public final String treatmentName()

      A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      Returns:
      A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

    • priority

      public final Integer priority()

      Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

      Returns:
      Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

    • toBuilder

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

    • builder

      public static WriteCampaignRequest.Builder builder()

    • serializableBuilderClass

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