WriteCampaignRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.WriteCampaignRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WriteCampaignRequest()

Constructors
Constructor and Description
`WriteCampaignRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteCampaignRequest`	`addTagsEntry(String key, String value)`
`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.
`String`	`getDescription()` The 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 use 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()` The custom name of the campaign.
`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()` A string-to-string map of key-value pairs that defines the tags to associate with the campaign.
`TemplateConfiguration`	`getTemplateConfiguration()`
`String`	`getTreatmentDescription()` The custom description of a variation of the campaign to use for A/B testing.
`String`	`getTreatmentName()` The custom name of a variation of the campaign to use for A/B testing.
`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`	`setDescription(String description)` The 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 use 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)` The custom name of the campaign.
`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)` A string-to-string map of key-value pairs that defines the tags to associate with the campaign.
`void`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)`
`void`	`setTreatmentDescription(String treatmentDescription)` The custom description of a variation of the campaign to use for A/B testing.
`void`	`setTreatmentName(String treatmentName)` The custom name of a variation of the campaign to use for A/B testing.
`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`	`withDescription(String description)` The 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 use 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)` The custom name of the campaign.
`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)` A string-to-string map of key-value pairs that defines the tags to associate with the campaign.
`WriteCampaignRequest`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)`
`WriteCampaignRequest`	`withTreatmentDescription(String treatmentDescription)` The custom description of a variation of the campaign to use for A/B testing.
`WriteCampaignRequest`	`withTreatmentName(String treatmentName)` The custom name of a variation of the campaign to use for A/B testing.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WriteCampaignRequest
```
public WriteCampaignRequest()
```
- Method Detail
  - getAdditionalTreatments
```
public List<WriteTreatmentResource> getAdditionalTreatments()
```
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Returns:
    
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
  - setAdditionalTreatments
```
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.
    
    Parameters:
    
    additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
  - withAdditionalTreatments
```
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.
    
    Parameters:
    
    additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalTreatments
```
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.
    
    Parameters:
    
    additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The custom description of the campaign.
    
    Parameters:
    
    description - The custom description of the campaign.
  - getDescription
```
public String getDescription()
```
    The custom description of the campaign.
    
    Returns:
    
    The custom description of the campaign.
  - withDescription
```
public WriteCampaignRequest withDescription(String description)
```
    The custom description of the campaign.
    
    Parameters:
    
    description - The custom description of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHoldoutPercent
```
public void setHoldoutPercent(Integer holdoutPercent)
```
    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
  - getHoldoutPercent
```
public Integer getHoldoutPercent()
```
    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.
  - withHoldoutPercent
```
public WriteCampaignRequest withHoldoutPercent(Integer holdoutPercent)
```
    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHook
```
public void setHook(CampaignHook hook)
```
    The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign.
  - getHook
```
public CampaignHook getHook()
```
    The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Returns:
    
    The settings for the AWS Lambda function to use as a code hook for the campaign.
  - withHook
```
public WriteCampaignRequest withHook(CampaignHook hook)
```
    The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsPaused
```
public void setIsPaused(Boolean isPaused)
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Parameters:
    
    isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
  - getIsPaused
```
public Boolean getIsPaused()
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Returns:
    
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
  - withIsPaused
```
public WriteCampaignRequest withIsPaused(Boolean isPaused)
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Parameters:
    
    isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPaused
```
public Boolean isPaused()
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Returns:
    
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
  - setLimits
```
public void setLimits(CampaignLimits limits)
```
    The messaging limits for the campaign.
    
    Parameters:
    
    limits - The messaging limits for the campaign.
  - getLimits
```
public CampaignLimits getLimits()
```
    The messaging limits for the campaign.
    
    Returns:
    
    The messaging limits for the campaign.
  - withLimits
```
public WriteCampaignRequest withLimits(CampaignLimits limits)
```
    The messaging limits for the campaign.
    
    Parameters:
    
    limits - The messaging limits for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageConfiguration
```
public void setMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings for the campaign.
    
    Parameters:
    
    messageConfiguration - The message configuration settings for the campaign.
  - getMessageConfiguration
```
public MessageConfiguration getMessageConfiguration()
```
    The message configuration settings for the campaign.
    
    Returns:
    
    The message configuration settings for the campaign.
  - withMessageConfiguration
```
public WriteCampaignRequest withMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings for the campaign.
    
    Parameters:
    
    messageConfiguration - The message configuration settings for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The custom name of the campaign.
    
    Parameters:
    
    name - The custom name of the campaign.
  - getName
```
public String getName()
```
    The custom name of the campaign.
    
    Returns:
    
    The custom name of the campaign.
  - withName
```
public WriteCampaignRequest withName(String name)
```
    The custom name of the campaign.
    
    Parameters:
    
    name - The custom name of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedule
```
public void setSchedule(Schedule schedule)
```
    The schedule settings for the campaign.
    
    Parameters:
    
    schedule - The schedule settings for the campaign.
  - getSchedule
```
public Schedule getSchedule()
```
    The schedule settings for the campaign.
    
    Returns:
    
    The schedule settings for the campaign.
  - withSchedule
```
public WriteCampaignRequest withSchedule(Schedule schedule)
```
    The schedule settings for the campaign.
    
    Parameters:
    
    schedule - The schedule settings for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentId
```
public void setSegmentId(String segmentId)
```
    The unique identifier for the segment to associate with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment to associate with the campaign.
  - getSegmentId
```
public String getSegmentId()
```
    The unique identifier for the segment to associate with the campaign.
    
    Returns:
    
    The unique identifier for the segment to associate with the campaign.
  - withSegmentId
```
public WriteCampaignRequest withSegmentId(String segmentId)
```
    The unique identifier for the segment to associate with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment to associate with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentVersion
```
public void setSegmentVersion(Integer segmentVersion)
```
    The version of the segment to associate with the campaign.
    
    Parameters:
    
    segmentVersion - The version of the segment to associate with the campaign.
  - getSegmentVersion
```
public Integer getSegmentVersion()
```
    The version of the segment to associate with the campaign.
    
    Returns:
    
    The version of the segment to associate with the campaign.
  - withSegmentVersion
```
public WriteCampaignRequest withSegmentVersion(Integer segmentVersion)
```
    The version of the segment to associate with the campaign.
    
    Parameters:
    
    segmentVersion - The version of the segment to associate with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    Returns:
    
    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.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    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.
    
    Parameters:
    
    tags - 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.
  - withTags
```
public WriteCampaignRequest withTags(Map<String,String> tags)
```
    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.
    
    Parameters:
    
    tags - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public WriteCampaignRequest addTagsEntry(String key,
                                         String value)
```
  - clearTagsEntries
```
public WriteCampaignRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateConfiguration
```
public void setTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    Parameters:
    
    templateConfiguration -
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    Returns:
  - withTemplateConfiguration
```
public WriteCampaignRequest withTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    Parameters:
    
    templateConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentDescription
```
public void setTreatmentDescription(String treatmentDescription)
```
    The custom description of a variation of the campaign to use for A/B testing.
    
    Parameters:
    
    treatmentDescription - The custom description of a variation of the campaign to use for A/B testing.
  - getTreatmentDescription
```
public String getTreatmentDescription()
```
    The custom description of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    The custom description of a variation of the campaign to use for A/B testing.
  - withTreatmentDescription
```
public WriteCampaignRequest withTreatmentDescription(String treatmentDescription)
```
    The custom description of a variation of the campaign to use for A/B testing.
    
    Parameters:
    
    treatmentDescription - The custom description of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentName
```
public void setTreatmentName(String treatmentName)
```
    The custom name of a variation of the campaign to use for A/B testing.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign to use for A/B testing.
  - getTreatmentName
```
public String getTreatmentName()
```
    The custom name of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    The custom name of a variation of the campaign to use for A/B testing.
  - withTreatmentName
```
public WriteCampaignRequest withTreatmentName(String treatmentName)
```
    The custom name of a variation of the campaign to use for A/B testing.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WriteCampaignRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WriteCampaignRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WriteCampaignRequest

Method Detail

getAdditionalTreatments

setAdditionalTreatments

withAdditionalTreatments

withAdditionalTreatments

setDescription

getDescription

withDescription

setHoldoutPercent

getHoldoutPercent

withHoldoutPercent

setHook

getHook

withHook

setIsPaused

getIsPaused

withIsPaused

isPaused

setLimits

getLimits

withLimits

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setName

getName

withName

setSchedule

getSchedule

withSchedule

setSegmentId

getSegmentId

withSegmentId

setSegmentVersion

getSegmentVersion

withSegmentVersion

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTreatmentDescription

getTreatmentDescription

withTreatmentDescription

setTreatmentName

getTreatmentName

withTreatmentName

toString

equals

hashCode

clone

marshall