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

Used to create 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`	`clone()`
`boolean`	`equals(Object obj)`
`List<WriteTreatmentResource>`	`getAdditionalTreatments()` Treatments that are defined in addition to the default treatment.
`String`	`getDescription()` A description of the campaign.
`Integer`	`getHoldoutPercent()` The allocated percentage of end users who will not receive messages from this campaign.
`Boolean`	`getIsPaused()` Indicates whether the campaign is paused.
`CampaignLimits`	`getLimits()` The campaign limits settings.
`MessageConfiguration`	`getMessageConfiguration()` The message configuration settings.
`String`	`getName()` The custom name of the campaign.
`Schedule`	`getSchedule()` The campaign schedule.
`String`	`getSegmentId()` The ID of the segment to which the campaign sends messages.
`Integer`	`getSegmentVersion()` The version of the segment to which the campaign sends messages.
`String`	`getTreatmentDescription()` A custom description for the treatment.
`String`	`getTreatmentName()` The custom name of a variation of the campaign used for A/B testing.
`int`	`hashCode()`
`Boolean`	`isPaused()` Indicates whether the campaign is paused.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)` Treatments that are defined in addition to the default treatment.
`void`	`setDescription(String description)` A description of the campaign.
`void`	`setHoldoutPercent(Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`void`	`setIsPaused(Boolean isPaused)` Indicates whether the campaign is paused.
`void`	`setLimits(CampaignLimits limits)` The campaign limits settings.
`void`	`setMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings.
`void`	`setName(String name)` The custom name of the campaign.
`void`	`setSchedule(Schedule schedule)` The campaign schedule.
`void`	`setSegmentId(String segmentId)` The ID of the segment to which the campaign sends messages.
`void`	`setSegmentVersion(Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`void`	`setTreatmentDescription(String treatmentDescription)` A custom description for the treatment.
`void`	`setTreatmentName(String treatmentName)` The custom name of a variation of the campaign used for A/B testing.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`WriteCampaignRequest`	`withAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)` Treatments that are defined in addition to the default treatment.
`WriteCampaignRequest`	`withAdditionalTreatments(WriteTreatmentResource... additionalTreatments)` Treatments that are defined in addition to the default treatment.
`WriteCampaignRequest`	`withDescription(String description)` A description of the campaign.
`WriteCampaignRequest`	`withHoldoutPercent(Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`WriteCampaignRequest`	`withIsPaused(Boolean isPaused)` Indicates whether the campaign is paused.
`WriteCampaignRequest`	`withLimits(CampaignLimits limits)` The campaign limits settings.
`WriteCampaignRequest`	`withMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings.
`WriteCampaignRequest`	`withName(String name)` The custom name of the campaign.
`WriteCampaignRequest`	`withSchedule(Schedule schedule)` The campaign schedule.
`WriteCampaignRequest`	`withSegmentId(String segmentId)` The ID of the segment to which the campaign sends messages.
`WriteCampaignRequest`	`withSegmentVersion(Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`WriteCampaignRequest`	`withTreatmentDescription(String treatmentDescription)` A custom description for the treatment.
`WriteCampaignRequest`	`withTreatmentName(String treatmentName)` The custom name of a variation of the campaign used 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()
```
    Treatments that are defined in addition to the default treatment.
    
    Returns:
    
    Treatments that are defined in addition to the default treatment.
  - setAdditionalTreatments
```
public void setAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
```
    Treatments that are defined in addition to the default treatment.
    
    Parameters:
    
    additionalTreatments - Treatments that are defined in addition to the default treatment.
  - withAdditionalTreatments
```
public WriteCampaignRequest withAdditionalTreatments(WriteTreatmentResource... additionalTreatments)
```
    Treatments that are defined in addition to the default treatment.
    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 - Treatments that are defined in addition to the default treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalTreatments
```
public WriteCampaignRequest withAdditionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
```
    Treatments that are defined in addition to the default treatment.
    
    Parameters:
    
    additionalTreatments - Treatments that are defined in addition to the default treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the campaign.
    
    Parameters:
    
    description - A description of the campaign.
  - getDescription
```
public String getDescription()
```
    A description of the campaign.
    
    Returns:
    
    A description of the campaign.
  - withDescription
```
public WriteCampaignRequest withDescription(String description)
```
    A description of the campaign.
    
    Parameters:
    
    description - A 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 end users who will not receive messages from this campaign.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of end users who will not receive messages from this campaign.
  - getHoldoutPercent
```
public Integer getHoldoutPercent()
```
    The allocated percentage of end users who will not receive messages from this campaign.
    
    Returns:
    
    The allocated percentage of end users who will not receive messages from this campaign.
  - withHoldoutPercent
```
public WriteCampaignRequest withHoldoutPercent(Integer holdoutPercent)
```
    The allocated percentage of end users who will not receive messages from this campaign.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of end users who will not receive messages from this campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsPaused
```
public void setIsPaused(Boolean isPaused)
```
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Parameters:
    
    isPaused - Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - getIsPaused
```
public Boolean getIsPaused()
```
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Returns:
    
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - withIsPaused
```
public WriteCampaignRequest withIsPaused(Boolean isPaused)
```
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Parameters:
    
    isPaused - Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPaused
```
public Boolean isPaused()
```
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Returns:
    
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - setLimits
```
public void setLimits(CampaignLimits limits)
```
    The campaign limits settings.
    
    Parameters:
    
    limits - The campaign limits settings.
  - getLimits
```
public CampaignLimits getLimits()
```
    The campaign limits settings.
    
    Returns:
    
    The campaign limits settings.
  - withLimits
```
public WriteCampaignRequest withLimits(CampaignLimits limits)
```
    The campaign limits settings.
    
    Parameters:
    
    limits - The campaign limits settings.
    
    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.
    
    Parameters:
    
    messageConfiguration - The message configuration settings.
  - getMessageConfiguration
```
public MessageConfiguration getMessageConfiguration()
```
    The message configuration settings.
    
    Returns:
    
    The message configuration settings.
  - withMessageConfiguration
```
public WriteCampaignRequest withMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings.
    
    Parameters:
    
    messageConfiguration - The message configuration settings.
    
    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 campaign schedule.
    
    Parameters:
    
    schedule - The campaign schedule.
  - getSchedule
```
public Schedule getSchedule()
```
    The campaign schedule.
    
    Returns:
    
    The campaign schedule.
  - withSchedule
```
public WriteCampaignRequest withSchedule(Schedule schedule)
```
    The campaign schedule.
    
    Parameters:
    
    schedule - The campaign schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentId
```
public void setSegmentId(String segmentId)
```
    The ID of the segment to which the campaign sends messages.
    
    Parameters:
    
    segmentId - The ID of the segment to which the campaign sends messages.
  - getSegmentId
```
public String getSegmentId()
```
    The ID of the segment to which the campaign sends messages.
    
    Returns:
    
    The ID of the segment to which the campaign sends messages.
  - withSegmentId
```
public WriteCampaignRequest withSegmentId(String segmentId)
```
    The ID of the segment to which the campaign sends messages.
    
    Parameters:
    
    segmentId - The ID of the segment to which the campaign sends messages.
    
    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 which the campaign sends messages.
    
    Parameters:
    
    segmentVersion - The version of the segment to which the campaign sends messages.
  - getSegmentVersion
```
public Integer getSegmentVersion()
```
    The version of the segment to which the campaign sends messages.
    
    Returns:
    
    The version of the segment to which the campaign sends messages.
  - withSegmentVersion
```
public WriteCampaignRequest withSegmentVersion(Integer segmentVersion)
```
    The version of the segment to which the campaign sends messages.
    
    Parameters:
    
    segmentVersion - The version of the segment to which the campaign sends messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentDescription
```
public void setTreatmentDescription(String treatmentDescription)
```
    A custom description for the treatment.
    
    Parameters:
    
    treatmentDescription - A custom description for the treatment.
  - getTreatmentDescription
```
public String getTreatmentDescription()
```
    A custom description for the treatment.
    
    Returns:
    
    A custom description for the treatment.
  - withTreatmentDescription
```
public WriteCampaignRequest withTreatmentDescription(String treatmentDescription)
```
    A custom description for the treatment.
    
    Parameters:
    
    treatmentDescription - A custom description for the treatment.
    
    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 used for A/B testing.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign used for A/B testing.
  - getTreatmentName
```
public String getTreatmentName()
```
    The custom name of a variation of the campaign used for A/B testing.
    
    Returns:
    
    The custom name of a variation of the campaign used for A/B testing.
  - withTreatmentName
```
public WriteCampaignRequest withTreatmentName(String treatmentName)
```
    The custom name of a variation of the campaign used for A/B testing.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign used 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; useful for testing and debugging.
    
    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

setIsPaused

getIsPaused

withIsPaused

isPaused

setLimits

getLimits

withLimits

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setName

getName

withName

setSchedule

getSchedule

withSchedule

setSegmentId

getSegmentId

withSegmentId

setSegmentVersion

getSegmentVersion

withSegmentVersion

setTreatmentDescription

getTreatmentDescription

withTreatmentDescription

setTreatmentName

getTreatmentName

withTreatmentName

toString

equals

hashCode

clone

marshall