CampaignResponse (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignResponse
extends Object
implements Serializable, Cloneable, StructuredPojo

Campaign definition

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignResponse()

Constructors
Constructor and Description
`CampaignResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignResponse`	`clone()`
`boolean`	`equals(Object obj)`
`List<TreatmentResource>`	`getAdditionalTreatments()` Treatments that are defined in addition to the default treatment.
`String`	`getApplicationId()` The ID of the application to which the campaign applies.
`String`	`getCreationDate()` The date the campaign was created in ISO 8601 format.
`CampaignState`	`getDefaultState()` The status of the campaign's 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.
`String`	`getId()` The unique campaign ID.
`Boolean`	`getIsPaused()` Indicates whether the campaign is paused.
`String`	`getLastModifiedDate()` The date the campaign was last updated in ISO 8601 format.
`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.
`CampaignState`	`getState()` The campaign status.
`String`	`getTreatmentDescription()` A custom description for the treatment.
`String`	`getTreatmentName()` The custom name of a variation of the campaign used for A/B testing.
`Integer`	`getVersion()` The campaign version number.
`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<TreatmentResource> additionalTreatments)` Treatments that are defined in addition to the default treatment.
`void`	`setApplicationId(String applicationId)` The ID of the application to which the campaign applies.
`void`	`setCreationDate(String creationDate)` The date the campaign was created in ISO 8601 format.
`void`	`setDefaultState(CampaignState defaultState)` The status of the campaign's 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`	`setId(String id)` The unique campaign ID.
`void`	`setIsPaused(Boolean isPaused)` Indicates whether the campaign is paused.
`void`	`setLastModifiedDate(String lastModifiedDate)` The date the campaign was last updated in ISO 8601 format.
`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`	`setState(CampaignState state)` The campaign status.
`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.
`void`	`setVersion(Integer version)` The campaign version number.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CampaignResponse`	`withAdditionalTreatments(Collection<TreatmentResource> additionalTreatments)` Treatments that are defined in addition to the default treatment.
`CampaignResponse`	`withAdditionalTreatments(TreatmentResource... additionalTreatments)` Treatments that are defined in addition to the default treatment.
`CampaignResponse`	`withApplicationId(String applicationId)` The ID of the application to which the campaign applies.
`CampaignResponse`	`withCreationDate(String creationDate)` The date the campaign was created in ISO 8601 format.
`CampaignResponse`	`withDefaultState(CampaignState defaultState)` The status of the campaign's default treatment.
`CampaignResponse`	`withDescription(String description)` A description of the campaign.
`CampaignResponse`	`withHoldoutPercent(Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`CampaignResponse`	`withId(String id)` The unique campaign ID.
`CampaignResponse`	`withIsPaused(Boolean isPaused)` Indicates whether the campaign is paused.
`CampaignResponse`	`withLastModifiedDate(String lastModifiedDate)` The date the campaign was last updated in ISO 8601 format.
`CampaignResponse`	`withLimits(CampaignLimits limits)` The campaign limits settings.
`CampaignResponse`	`withMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings.
`CampaignResponse`	`withName(String name)` The custom name of the campaign.
`CampaignResponse`	`withSchedule(Schedule schedule)` The campaign schedule.
`CampaignResponse`	`withSegmentId(String segmentId)` The ID of the segment to which the campaign sends messages.
`CampaignResponse`	`withSegmentVersion(Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`CampaignResponse`	`withState(CampaignState state)` The campaign status.
`CampaignResponse`	`withTreatmentDescription(String treatmentDescription)` A custom description for the treatment.
`CampaignResponse`	`withTreatmentName(String treatmentName)` The custom name of a variation of the campaign used for A/B testing.
`CampaignResponse`	`withVersion(Integer version)` The campaign version number.

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

- Constructor Detail
  - CampaignResponse
```
public CampaignResponse()
```
- Method Detail
  - getAdditionalTreatments
```
public List<TreatmentResource> 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<TreatmentResource> 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 CampaignResponse withAdditionalTreatments(TreatmentResource... 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 CampaignResponse withAdditionalTreatments(Collection<TreatmentResource> 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.
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The ID of the application to which the campaign applies.
    
    Parameters:
    
    applicationId - The ID of the application to which the campaign applies.
  - getApplicationId
```
public String getApplicationId()
```
    The ID of the application to which the campaign applies.
    
    Returns:
    
    The ID of the application to which the campaign applies.
  - withApplicationId
```
public CampaignResponse withApplicationId(String applicationId)
```
    The ID of the application to which the campaign applies.
    
    Parameters:
    
    applicationId - The ID of the application to which the campaign applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The date the campaign was created in ISO 8601 format.
    
    Parameters:
    
    creationDate - The date the campaign was created in ISO 8601 format.
  - getCreationDate
```
public String getCreationDate()
```
    The date the campaign was created in ISO 8601 format.
    
    Returns:
    
    The date the campaign was created in ISO 8601 format.
  - withCreationDate
```
public CampaignResponse withCreationDate(String creationDate)
```
    The date the campaign was created in ISO 8601 format.
    
    Parameters:
    
    creationDate - The date the campaign was created in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultState
```
public void setDefaultState(CampaignState defaultState)
```
    The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    Parameters:
    
    defaultState - The status of the campaign's default treatment. Only present for A/B test campaigns.
  - getDefaultState
```
public CampaignState getDefaultState()
```
    The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    Returns:
    
    The status of the campaign's default treatment. Only present for A/B test campaigns.
  - withDefaultState
```
public CampaignResponse withDefaultState(CampaignState defaultState)
```
    The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    Parameters:
    
    defaultState - The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    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 CampaignResponse 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 CampaignResponse 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.
  - setId
```
public void setId(String id)
```
    The unique campaign ID.
    
    Parameters:
    
    id - The unique campaign ID.
  - getId
```
public String getId()
```
    The unique campaign ID.
    
    Returns:
    
    The unique campaign ID.
  - withId
```
public CampaignResponse withId(String id)
```
    The unique campaign ID.
    
    Parameters:
    
    id - The unique campaign ID.
    
    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 CampaignResponse 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.
  - setLastModifiedDate
```
public void setLastModifiedDate(String lastModifiedDate)
```
    The date the campaign was last updated in ISO 8601 format.
    
    Parameters:
    
    lastModifiedDate - The date the campaign was last updated in ISO 8601 format.
  - getLastModifiedDate
```
public String getLastModifiedDate()
```
    The date the campaign was last updated in ISO 8601 format.
    
    Returns:
    
    The date the campaign was last updated in ISO 8601 format.
  - withLastModifiedDate
```
public CampaignResponse withLastModifiedDate(String lastModifiedDate)
```
    The date the campaign was last updated in ISO 8601 format.
    
    Parameters:
    
    lastModifiedDate - The date the campaign was last updated in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CampaignResponse 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 CampaignResponse 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 CampaignResponse 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 CampaignResponse 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 CampaignResponse 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 CampaignResponse 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.
  - setState
```
public void setState(CampaignState state)
```
    The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    Parameters:
    
    state - The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
  - getState
```
public CampaignState getState()
```
    The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    Returns:
    
    The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
  - withState
```
public CampaignResponse withState(CampaignState state)
```
    The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    Parameters:
    
    state - The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    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 CampaignResponse 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 CampaignResponse 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.
  - setVersion
```
public void setVersion(Integer version)
```
    The campaign version number.
    
    Parameters:
    
    version - The campaign version number.
  - getVersion
```
public Integer getVersion()
```
    The campaign version number.
    
    Returns:
    
    The campaign version number.
  - withVersion
```
public CampaignResponse withVersion(Integer version)
```
    The campaign version number.
    
    Parameters:
    
    version - The campaign version number.
    
    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 CampaignResponse 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 CampaignResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignResponse

Method Detail

getAdditionalTreatments

setAdditionalTreatments

withAdditionalTreatments

withAdditionalTreatments

setApplicationId

getApplicationId

withApplicationId

setCreationDate

getCreationDate

withCreationDate

setDefaultState

getDefaultState

withDefaultState

setDescription

getDescription

withDescription

setHoldoutPercent

getHoldoutPercent

withHoldoutPercent

setId

getId

withId

setIsPaused

getIsPaused

withIsPaused

isPaused

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setLimits

getLimits

withLimits

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setName

getName

withName

setSchedule

getSchedule

withSchedule

setSegmentId

getSegmentId

withSegmentId

setSegmentVersion

getSegmentVersion

withSegmentVersion

setState

getState

withState

setTreatmentDescription

getTreatmentDescription

withTreatmentDescription

setTreatmentName

getTreatmentName

withTreatmentName

setVersion

getVersion

withVersion

toString

equals

hashCode

clone

marshall