WriteCampaignRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class WriteCampaignRequest
extends java.lang.Object
implements java.io.Serializable
```
Used to create a campaign.

See Also:

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
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<WriteTreatmentResource>`	`getAdditionalTreatments()` Treatments that are defined in addition to the default treatment.
`java.lang.String`	`getDescription()` A description of the campaign.
`java.lang.Integer`	`getHoldoutPercent()` The allocated percentage of end users who will not receive messages from this campaign.
`CampaignHook`	`getHook()` Campaign hook information.
`java.lang.Boolean`	`getIsPaused()` Indicates whether the campaign is paused.
`CampaignLimits`	`getLimits()` The campaign limits settings.
`MessageConfiguration`	`getMessageConfiguration()` The message configuration settings.
`java.lang.String`	`getName()` The custom name of the campaign.
`Schedule`	`getSchedule()` The campaign schedule.
`java.lang.String`	`getSegmentId()` The ID of the segment to which the campaign sends messages.
`java.lang.Integer`	`getSegmentVersion()` The version of the segment to which the campaign sends messages.
`java.lang.String`	`getTreatmentDescription()` A custom description for the treatment.
`java.lang.String`	`getTreatmentName()` The custom name of a variation of the campaign used for A/B testing.
`int`	`hashCode()`
`java.lang.Boolean`	`isIsPaused()` Indicates whether the campaign is paused.
`void`	`setAdditionalTreatments(java.util.Collection<WriteTreatmentResource> additionalTreatments)` Treatments that are defined in addition to the default treatment.
`void`	`setDescription(java.lang.String description)` A description of the campaign.
`void`	`setHoldoutPercent(java.lang.Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`void`	`setHook(CampaignHook hook)` Campaign hook information.
`void`	`setIsPaused(java.lang.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(java.lang.String name)` The custom name of the campaign.
`void`	`setSchedule(Schedule schedule)` The campaign schedule.
`void`	`setSegmentId(java.lang.String segmentId)` The ID of the segment to which the campaign sends messages.
`void`	`setSegmentVersion(java.lang.Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`void`	`setTreatmentDescription(java.lang.String treatmentDescription)` A custom description for the treatment.
`void`	`setTreatmentName(java.lang.String treatmentName)` The custom name of a variation of the campaign used for A/B testing.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`WriteCampaignRequest`	`withAdditionalTreatments(java.util.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(java.lang.String description)` A description of the campaign.
`WriteCampaignRequest`	`withHoldoutPercent(java.lang.Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`WriteCampaignRequest`	`withHook(CampaignHook hook)` Campaign hook information.
`WriteCampaignRequest`	`withIsPaused(java.lang.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(java.lang.String name)` The custom name of the campaign.
`WriteCampaignRequest`	`withSchedule(Schedule schedule)` The campaign schedule.
`WriteCampaignRequest`	`withSegmentId(java.lang.String segmentId)` The ID of the segment to which the campaign sends messages.
`WriteCampaignRequest`	`withSegmentVersion(java.lang.Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`WriteCampaignRequest`	`withTreatmentDescription(java.lang.String treatmentDescription)` A custom description for the treatment.
`WriteCampaignRequest`	`withTreatmentName(java.lang.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 java.util.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(java.util.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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    additionalTreatments - Treatments that are defined in addition to the default treatment.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAdditionalTreatments
```
public WriteCampaignRequest withAdditionalTreatments(java.util.Collection<WriteTreatmentResource> additionalTreatments)
```
    Treatments that are defined in addition to the default treatment.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    additionalTreatments - Treatments that are defined in addition to the default treatment.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the campaign.
    
    Returns:
    
    A description of the campaign.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A description of the campaign.
    
    Parameters:
    
    description - A description of the campaign.
  - withDescription
```
public WriteCampaignRequest withDescription(java.lang.String description)
```
    A description of the campaign.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    description - A description of the campaign.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHoldoutPercent
```
public java.lang.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.
  - setHoldoutPercent
```
public void setHoldoutPercent(java.lang.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.
  - withHoldoutPercent
```
public WriteCampaignRequest withHoldoutPercent(java.lang.Integer holdoutPercent)
```
    The allocated percentage of end users who will not receive messages from this campaign.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of end users who will not receive messages from this campaign.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHook
```
public CampaignHook getHook()
```
    Campaign hook information.
    
    Returns:
    
    Campaign hook information.
  - setHook
```
public void setHook(CampaignHook hook)
```
    Campaign hook information.
    
    Parameters:
    
    hook - Campaign hook information.
  - withHook
```
public WriteCampaignRequest withHook(CampaignHook hook)
```
    Campaign hook information.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    hook - Campaign hook information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isIsPaused
```
public java.lang.Boolean isIsPaused()
```
    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.
  - getIsPaused
```
public java.lang.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.
  - setIsPaused
```
public void setIsPaused(java.lang.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.
  - withIsPaused
```
public WriteCampaignRequest withIsPaused(java.lang.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 a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimits
```
public CampaignLimits getLimits()
```
    The campaign limits settings.
    
    Returns:
    
    The campaign limits settings.
  - setLimits
```
public void setLimits(CampaignLimits limits)
```
    The campaign limits settings.
    
    Parameters:
    
    limits - The campaign limits settings.
  - withLimits
```
public WriteCampaignRequest withLimits(CampaignLimits limits)
```
    The campaign limits settings.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    limits - The campaign limits settings.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageConfiguration
```
public MessageConfiguration getMessageConfiguration()
```
    The message configuration settings.
    
    Returns:
    
    The message configuration settings.
  - setMessageConfiguration
```
public void setMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings.
    
    Parameters:
    
    messageConfiguration - The message configuration settings.
  - withMessageConfiguration
```
public WriteCampaignRequest withMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    messageConfiguration - The message configuration settings.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public java.lang.String getName()
```
    The custom name of the campaign.
    
    Returns:
    
    The custom name of the campaign.
  - setName
```
public void setName(java.lang.String name)
```
    The custom name of the campaign.
    
    Parameters:
    
    name - The custom name of the campaign.
  - withName
```
public WriteCampaignRequest withName(java.lang.String name)
```
    The custom name of the campaign.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    name - The custom name of the campaign.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSchedule
```
public Schedule getSchedule()
```
    The campaign schedule.
    
    Returns:
    
    The campaign schedule.
  - setSchedule
```
public void setSchedule(Schedule schedule)
```
    The campaign schedule.
    
    Parameters:
    
    schedule - The campaign schedule.
  - withSchedule
```
public WriteCampaignRequest withSchedule(Schedule schedule)
```
    The campaign schedule.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    schedule - The campaign schedule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSegmentId
```
public java.lang.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.
  - setSegmentId
```
public void setSegmentId(java.lang.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.
  - withSegmentId
```
public WriteCampaignRequest withSegmentId(java.lang.String segmentId)
```
    The ID of the segment to which the campaign sends messages.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    segmentId - The ID of the segment to which the campaign sends messages.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSegmentVersion
```
public java.lang.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.
  - setSegmentVersion
```
public void setSegmentVersion(java.lang.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.
  - withSegmentVersion
```
public WriteCampaignRequest withSegmentVersion(java.lang.Integer segmentVersion)
```
    The version of the segment to which the campaign sends messages.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    segmentVersion - The version of the segment to which the campaign sends messages.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTreatmentDescription
```
public java.lang.String getTreatmentDescription()
```
    A custom description for the treatment.
    
    Returns:
    
    A custom description for the treatment.
  - setTreatmentDescription
```
public void setTreatmentDescription(java.lang.String treatmentDescription)
```
    A custom description for the treatment.
    
    Parameters:
    
    treatmentDescription - A custom description for the treatment.
  - withTreatmentDescription
```
public WriteCampaignRequest withTreatmentDescription(java.lang.String treatmentDescription)
```
    A custom description for the treatment.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    treatmentDescription - A custom description for the treatment.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTreatmentName
```
public java.lang.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.
  - setTreatmentName
```
public void setTreatmentName(java.lang.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.
  - withTreatmentName
```
public WriteCampaignRequest withTreatmentName(java.lang.String treatmentName)
```
    The custom name of a variation of the campaign used for A/B testing.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign used for A/B testing.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class WriteCampaignRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WriteCampaignRequest

Method Detail

getAdditionalTreatments

setAdditionalTreatments

withAdditionalTreatments

withAdditionalTreatments

getDescription

setDescription

withDescription

getHoldoutPercent

setHoldoutPercent

withHoldoutPercent

getHook

setHook

withHook

isIsPaused

getIsPaused

setIsPaused

withIsPaused

getLimits

setLimits

withLimits

getMessageConfiguration

setMessageConfiguration

withMessageConfiguration

getName

setName

withName

getSchedule

setSchedule

withSchedule

getSegmentId

setSegmentId

withSegmentId

getSegmentVersion

setSegmentVersion

withSegmentVersion

getTreatmentDescription

setTreatmentDescription

withTreatmentDescription

getTreatmentName

setTreatmentName

withTreatmentName

toString

hashCode

equals