@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WriteCampaignRequest extends Object implements Serializable, Cloneable, StructuredPojo
Specifies the configuration and other settings for a campaign.
Constructor and Description |
---|
WriteCampaignRequest() |
Modifier and Type | Method and Description |
---|---|
WriteCampaignRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
WriteCampaignRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
WriteCampaignRequest |
clone() |
boolean |
equals(Object obj) |
List<WriteTreatmentResource> |
getAdditionalTreatments()
An array of requests that defines additional treatments for the campaign, in addition to the default treatment
for the campaign.
|
CustomDeliveryConfiguration |
getCustomDeliveryConfiguration()
The delivery configuration settings for sending the campaign through a custom channel.
|
String |
getDescription()
A custom description of the campaign.
|
Integer |
getHoldoutPercent()
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
CampaignHook |
getHook()
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
|
Boolean |
getIsPaused()
Specifies whether to pause the campaign.
|
CampaignLimits |
getLimits()
The messaging limits for the campaign.
|
MessageConfiguration |
getMessageConfiguration()
The message configuration settings for the campaign.
|
String |
getName()
A custom name for the campaign.
|
Integer |
getPriority()
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.
|
Schedule |
getSchedule()
The schedule settings for the campaign.
|
String |
getSegmentId()
The unique identifier for the segment to associate with the campaign.
|
Integer |
getSegmentVersion()
The version of the segment to associate with the campaign.
|
Map<String,String> |
getTags()
|
TemplateConfiguration |
getTemplateConfiguration()
The message template to use for the campaign.
|
String |
getTreatmentDescription()
A custom description of the default treatment for the campaign.
|
String |
getTreatmentName()
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
int |
hashCode() |
Boolean |
isPaused()
Specifies whether to pause the campaign.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment
for the campaign.
|
void |
setCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel.
|
void |
setDescription(String description)
A custom description of the campaign.
|
void |
setHoldoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
void |
setHook(CampaignHook hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
|
void |
setIsPaused(Boolean isPaused)
Specifies whether to pause the campaign.
|
void |
setLimits(CampaignLimits limits)
The messaging limits for the campaign.
|
void |
setMessageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
|
void |
setName(String name)
A custom name for the campaign.
|
void |
setPriority(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.
|
void |
setSchedule(Schedule schedule)
The schedule settings for the campaign.
|
void |
setSegmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
|
void |
setSegmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
|
void |
setTags(Map<String,String> tags)
|
void |
setTemplateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
|
void |
setTreatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
|
void |
setTreatmentName(String treatmentName)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
String |
toString()
Returns a string representation of this object.
|
WriteCampaignRequest |
withAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment
for the campaign.
|
WriteCampaignRequest |
withAdditionalTreatments(WriteTreatmentResource... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment
for the campaign.
|
WriteCampaignRequest |
withCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel.
|
WriteCampaignRequest |
withDescription(String description)
A custom description of the campaign.
|
WriteCampaignRequest |
withHoldoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
WriteCampaignRequest |
withHook(CampaignHook hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
|
WriteCampaignRequest |
withIsPaused(Boolean isPaused)
Specifies whether to pause the campaign.
|
WriteCampaignRequest |
withLimits(CampaignLimits limits)
The messaging limits for the campaign.
|
WriteCampaignRequest |
withMessageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
|
WriteCampaignRequest |
withName(String name)
A custom name for the campaign.
|
WriteCampaignRequest |
withPriority(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.
|
WriteCampaignRequest |
withSchedule(Schedule schedule)
The schedule settings for the campaign.
|
WriteCampaignRequest |
withSegmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
|
WriteCampaignRequest |
withSegmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
|
WriteCampaignRequest |
withTags(Map<String,String> tags)
|
WriteCampaignRequest |
withTemplateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
|
WriteCampaignRequest |
withTreatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
|
WriteCampaignRequest |
withTreatmentName(String treatmentName)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
public List<WriteTreatmentResource> getAdditionalTreatments()
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
public void setAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
additionalTreatments
- An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.public WriteCampaignRequest withAdditionalTreatments(WriteTreatmentResource... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
NOTE: This method appends the values to the existing list (if any). Use
setAdditionalTreatments(java.util.Collection)
or withAdditionalTreatments(java.util.Collection)
if you want to override the existing values.
additionalTreatments
- An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.public WriteCampaignRequest withAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
additionalTreatments
- An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.public void setCustomDeliveryConfiguration(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.
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.public CustomDeliveryConfiguration getCustomDeliveryConfiguration()
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.
public WriteCampaignRequest withCustomDeliveryConfiguration(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.
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.public void setDescription(String description)
A custom description of the campaign.
description
- A custom description of the campaign.public String getDescription()
A custom description of the campaign.
public WriteCampaignRequest withDescription(String description)
A custom description of the campaign.
description
- A custom description of the campaign.public void setHoldoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
holdoutPercent
- The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.public Integer getHoldoutPercent()
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
public WriteCampaignRequest withHoldoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
holdoutPercent
- The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.public void setHook(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.
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.public CampaignHook getHook()
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.
public WriteCampaignRequest withHook(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.
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.public void setIsPaused(Boolean isPaused)
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
isPaused
- Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing
this value to false.public Boolean getIsPaused()
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
public WriteCampaignRequest withIsPaused(Boolean isPaused)
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
isPaused
- Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing
this value to false.public Boolean isPaused()
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
public void setLimits(CampaignLimits limits)
The messaging limits for the campaign.
limits
- The messaging limits for the campaign.public CampaignLimits getLimits()
The messaging limits for the campaign.
public WriteCampaignRequest withLimits(CampaignLimits limits)
The messaging limits for the campaign.
limits
- The messaging limits for the campaign.public void setMessageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
messageConfiguration
- The message configuration settings for the campaign.public MessageConfiguration getMessageConfiguration()
The message configuration settings for the campaign.
public WriteCampaignRequest withMessageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
messageConfiguration
- The message configuration settings for the campaign.public void setName(String name)
A custom name for the campaign.
name
- A custom name for the campaign.public String getName()
A custom name for the campaign.
public WriteCampaignRequest withName(String name)
A custom name for the campaign.
name
- A custom name for the campaign.public void setSchedule(Schedule schedule)
The schedule settings for the campaign.
schedule
- The schedule settings for the campaign.public Schedule getSchedule()
The schedule settings for the campaign.
public WriteCampaignRequest withSchedule(Schedule schedule)
The schedule settings for the campaign.
schedule
- The schedule settings for the campaign.public void setSegmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
segmentId
- The unique identifier for the segment to associate with the campaign.public String getSegmentId()
The unique identifier for the segment to associate with the campaign.
public WriteCampaignRequest withSegmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
segmentId
- The unique identifier for the segment to associate with the campaign.public void setSegmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
segmentVersion
- The version of the segment to associate with the campaign.public Integer getSegmentVersion()
The version of the segment to associate with the campaign.
public WriteCampaignRequest withSegmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
segmentVersion
- The version of the segment to associate with the campaign.public Map<String,String> getTags()
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.
public void setTags(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.
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.public WriteCampaignRequest withTags(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.
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.public WriteCampaignRequest addTagsEntry(String key, String value)
public WriteCampaignRequest clearTagsEntries()
public void setTemplateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
templateConfiguration
- The message template to use for the campaign.public TemplateConfiguration getTemplateConfiguration()
The message template to use for the campaign.
public WriteCampaignRequest withTemplateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
templateConfiguration
- The message template to use for the campaign.public void setTreatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
treatmentDescription
- A custom description of the default treatment for the campaign.public String getTreatmentDescription()
A custom description of the default treatment for the campaign.
public WriteCampaignRequest withTreatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
treatmentDescription
- A custom description of the default treatment for the campaign.public void setTreatmentName(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.
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.public String getTreatmentName()
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.
public WriteCampaignRequest withTreatmentName(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.
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.public void setPriority(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.
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.public Integer getPriority()
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.
public WriteCampaignRequest withPriority(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.
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.public String toString()
toString
in class Object
Object.toString()
public WriteCampaignRequest clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.