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
```
Provides information about the status, configuration, and other settings for a campaign.

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`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CampaignResponse`	`clearTagsEntries()` Removes all the entries added into Tags.
`CampaignResponse`	`clone()`
`boolean`	`equals(Object obj)`
`List<TreatmentResource>`	`getAdditionalTreatments()` An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
`String`	`getApplicationId()` The unique identifier for the application that the campaign applies to.
`String`	`getArn()` The Amazon Resource Name (ARN) of the campaign.
`String`	`getCreationDate()` The date, in ISO 8601 format, when the campaign was created.
`CustomDeliveryConfiguration`	`getCustomDeliveryConfiguration()` The delivery configuration settings for sending the campaign through a custom channel.
`CampaignState`	`getDefaultState()` The current status of the campaign's default treatment.
`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.
`String`	`getId()` The unique identifier for the campaign.
`Boolean`	`getIsPaused()` Specifies whether the campaign is paused.
`String`	`getLastModifiedDate()` The date, in ISO 8601 format, when the campaign was last modified.
`CampaignLimits`	`getLimits()` The messaging limits for the campaign.
`MessageConfiguration`	`getMessageConfiguration()` The message configuration settings for the campaign.
`String`	`getName()` The name of 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 that's associated with the campaign.
`Integer`	`getSegmentVersion()` The version number of the segment that's associated with the campaign.
`CampaignState`	`getState()` The current status of the campaign.
`Map<String,String>`	`getTags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
`TemplateConfiguration`	`getTemplateConfiguration()` The message template that’s used for the campaign.
`String`	`getTreatmentDescription()` The custom description of the default treatment for the campaign.
`String`	`getTreatmentName()` The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
`Integer`	`getVersion()` The version number of the campaign.
`int`	`hashCode()`
`Boolean`	`isPaused()` Specifies whether the campaign is paused.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalTreatments(Collection<TreatmentResource> additionalTreatments)` An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
`void`	`setApplicationId(String applicationId)` The unique identifier for the application that the campaign applies to.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the campaign.
`void`	`setCreationDate(String creationDate)` The date, in ISO 8601 format, when the campaign was created.
`void`	`setCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)` The delivery configuration settings for sending the campaign through a custom channel.
`void`	`setDefaultState(CampaignState defaultState)` The current status of the campaign's default treatment.
`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`	`setId(String id)` The unique identifier for the campaign.
`void`	`setIsPaused(Boolean isPaused)` Specifies whether the campaign is paused.
`void`	`setLastModifiedDate(String lastModifiedDate)` The date, in ISO 8601 format, when the campaign was last modified.
`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 name of 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 that's associated with the campaign.
`void`	`setSegmentVersion(Integer segmentVersion)` The version number of the segment that's associated with the campaign.
`void`	`setState(CampaignState state)` The current status of the campaign.
`void`	`setTags(Map<String,String> tags)` A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
`void`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template that’s used for the campaign.
`void`	`setTreatmentDescription(String treatmentDescription)` The custom description of the default treatment for the campaign.
`void`	`setTreatmentName(String treatmentName)` The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
`void`	`setVersion(Integer version)` The version number of the campaign.
`String`	`toString()` Returns a string representation of this object.
`CampaignResponse`	`withAdditionalTreatments(Collection<TreatmentResource> additionalTreatments)` An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
`CampaignResponse`	`withAdditionalTreatments(TreatmentResource... additionalTreatments)` An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
`CampaignResponse`	`withApplicationId(String applicationId)` The unique identifier for the application that the campaign applies to.
`CampaignResponse`	`withArn(String arn)` The Amazon Resource Name (ARN) of the campaign.
`CampaignResponse`	`withCreationDate(String creationDate)` The date, in ISO 8601 format, when the campaign was created.
`CampaignResponse`	`withCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)` The delivery configuration settings for sending the campaign through a custom channel.
`CampaignResponse`	`withDefaultState(CampaignState defaultState)` The current status of the campaign's default treatment.
`CampaignResponse`	`withDescription(String description)` The custom description of the campaign.
`CampaignResponse`	`withHoldoutPercent(Integer holdoutPercent)` The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
`CampaignResponse`	`withHook(CampaignHook hook)` The settings for the AWS Lambda function to use as a code hook for the campaign.
`CampaignResponse`	`withId(String id)` The unique identifier for the campaign.
`CampaignResponse`	`withIsPaused(Boolean isPaused)` Specifies whether the campaign is paused.
`CampaignResponse`	`withLastModifiedDate(String lastModifiedDate)` The date, in ISO 8601 format, when the campaign was last modified.
`CampaignResponse`	`withLimits(CampaignLimits limits)` The messaging limits for the campaign.
`CampaignResponse`	`withMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings for the campaign.
`CampaignResponse`	`withName(String name)` The name of the campaign.
`CampaignResponse`	`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.
`CampaignResponse`	`withSchedule(Schedule schedule)` The schedule settings for the campaign.
`CampaignResponse`	`withSegmentId(String segmentId)` The unique identifier for the segment that's associated with the campaign.
`CampaignResponse`	`withSegmentVersion(Integer segmentVersion)` The version number of the segment that's associated with the campaign.
`CampaignResponse`	`withState(CampaignState state)` The current status of the campaign.
`CampaignResponse`	`withTags(Map<String,String> tags)` A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
`CampaignResponse`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template that’s used for the campaign.
`CampaignResponse`	`withTreatmentDescription(String treatmentDescription)` The custom description of the default treatment for the campaign.
`CampaignResponse`	`withTreatmentName(String treatmentName)` The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
`CampaignResponse`	`withVersion(Integer version)` The version number of the campaign.

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()
```
    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    Returns:
    
    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
  - setAdditionalTreatments
```
public void setAdditionalTreatments(Collection<TreatmentResource> additionalTreatments)
```
    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    Parameters:
    
    additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
  - withAdditionalTreatments
```
public CampaignResponse withAdditionalTreatments(TreatmentResource... additionalTreatments)
```
    An array of responses, one for each treatment that you defined for the campaign, 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 - An array of responses, one for each treatment that you defined for the campaign, 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)
```
    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    Parameters:
    
    additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, 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 unique identifier for the application that the campaign applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the campaign applies to.
  - getApplicationId
```
public String getApplicationId()
```
    The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    The unique identifier for the application that the campaign applies to.
  - withApplicationId
```
public CampaignResponse withApplicationId(String applicationId)
```
    The unique identifier for the application that the campaign applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the campaign.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the campaign.
  - withArn
```
public CampaignResponse withArn(String arn)
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the campaign was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the campaign was created.
  - getCreationDate
```
public String getCreationDate()
```
    The date, in ISO 8601 format, when the campaign was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the campaign was created.
  - withCreationDate
```
public CampaignResponse withCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the campaign was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the campaign was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomDeliveryConfiguration
```
public void setCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
```
    The delivery configuration settings for sending the campaign through a custom channel.
    
    Parameters:
    
    customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.
  - getCustomDeliveryConfiguration
```
public CustomDeliveryConfiguration getCustomDeliveryConfiguration()
```
    The delivery configuration settings for sending the campaign through a custom channel.
    
    Returns:
    
    The delivery configuration settings for sending the campaign through a custom channel.
  - withCustomDeliveryConfiguration
```
public CampaignResponse withCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
```
    The delivery configuration settings for sending the campaign through a custom channel.
    
    Parameters:
    
    customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultState
```
public void setDefaultState(CampaignState defaultState)
```
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    Parameters:
    
    defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
  - getDefaultState
```
public CampaignState getDefaultState()
```
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    Returns:
    
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
  - withDefaultState
```
public CampaignResponse withDefaultState(CampaignState defaultState)
```
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    Parameters:
    
    defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    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 CampaignResponse 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 CampaignResponse 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. You can use this hook to customize the segment that's used by the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
  - getHook
```
public CampaignHook getHook()
```
    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
    
    Returns:
    
    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
  - withHook
```
public CampaignResponse withHook(CampaignHook hook)
```
    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique identifier for the campaign.
    
    Parameters:
    
    id - The unique identifier for the campaign.
  - getId
```
public String getId()
```
    The unique identifier for the campaign.
    
    Returns:
    
    The unique identifier for the campaign.
  - withId
```
public CampaignResponse withId(String id)
```
    The unique identifier for the campaign.
    
    Parameters:
    
    id - The unique identifier 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 the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Parameters:
    
    isPaused - Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
  - getIsPaused
```
public Boolean getIsPaused()
```
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Returns:
    
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
  - withIsPaused
```
public CampaignResponse withIsPaused(Boolean isPaused)
```
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Parameters:
    
    isPaused - Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing 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 the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Returns:
    
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
  - setLastModifiedDate
```
public void setLastModifiedDate(String lastModifiedDate)
```
    The date, in ISO 8601 format, when the campaign was last modified.
    
    Parameters:
    
    lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.
  - getLastModifiedDate
```
public String getLastModifiedDate()
```
    The date, in ISO 8601 format, when the campaign was last modified.
    
    Returns:
    
    The date, in ISO 8601 format, when the campaign was last modified.
  - withLastModifiedDate
```
public CampaignResponse withLastModifiedDate(String lastModifiedDate)
```
    The date, in ISO 8601 format, when the campaign was last modified.
    
    Parameters:
    
    lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CampaignResponse 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 CampaignResponse 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 name of the campaign.
    
    Parameters:
    
    name - The name of the campaign.
  - getName
```
public String getName()
```
    The name of the campaign.
    
    Returns:
    
    The name of the campaign.
  - withName
```
public CampaignResponse withName(String name)
```
    The name of the campaign.
    
    Parameters:
    
    name - The 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 CampaignResponse 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 that's associated with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment that's associated with the campaign.
  - getSegmentId
```
public String getSegmentId()
```
    The unique identifier for the segment that's associated with the campaign.
    
    Returns:
    
    The unique identifier for the segment that's associated with the campaign.
  - withSegmentId
```
public CampaignResponse withSegmentId(String segmentId)
```
    The unique identifier for the segment that's associated with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment that's associated 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 number of the segment that's associated with the campaign.
    
    Parameters:
    
    segmentVersion - The version number of the segment that's associated with the campaign.
  - getSegmentVersion
```
public Integer getSegmentVersion()
```
    The version number of the segment that's associated with the campaign.
    
    Returns:
    
    The version number of the segment that's associated with the campaign.
  - withSegmentVersion
```
public CampaignResponse withSegmentVersion(Integer segmentVersion)
```
    The version number of the segment that's associated with the campaign.
    
    Parameters:
    
    segmentVersion - The version number of the segment that's associated with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(CampaignState state)
```
    The current status of the campaign.
    
    Parameters:
    
    state - The current status of the campaign.
  - getState
```
public CampaignState getState()
```
    The current status of the campaign.
    
    Returns:
    
    The current status of the campaign.
  - withState
```
public CampaignResponse withState(CampaignState state)
```
    The current status of the campaign.
    
    Parameters:
    
    state - The current status of 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 identifies the tags that are associated 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 identifies the tags that are associated 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 identifies the tags that are associated 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 identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
  - withTags
```
public CampaignResponse withTags(Map<String,String> tags)
```
    A string-to-string map of key-value pairs that identifies the tags that are associated 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 identifies the tags that are associated 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 CampaignResponse addTagsEntry(String key,
                                     String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CampaignResponse 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)
```
    The message template that’s used for the campaign.
    
    Parameters:
    
    templateConfiguration - The message template that’s used for the campaign.
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    The message template that’s used for the campaign.
    
    Returns:
    
    The message template that’s used for the campaign.
  - withTemplateConfiguration
```
public CampaignResponse withTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template that’s used for the campaign.
    
    Parameters:
    
    templateConfiguration - The message template that’s used for the campaign.
    
    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 the default treatment for the campaign.
    
    Parameters:
    
    treatmentDescription - The custom description of the default treatment for the campaign.
  - getTreatmentDescription
```
public String getTreatmentDescription()
```
    The custom description of the default treatment for the campaign.
    
    Returns:
    
    The custom description of the default treatment for the campaign.
  - withTreatmentDescription
```
public CampaignResponse withTreatmentDescription(String treatmentDescription)
```
    The custom description of the default treatment for the campaign.
    
    Parameters:
    
    treatmentDescription - The custom description of the default treatment for the campaign.
    
    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 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.
    
    Parameters:
    
    treatmentName - The 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.
  - getTreatmentName
```
public String getTreatmentName()
```
    The 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.
    
    Returns:
    
    The 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.
  - withTreatmentName
```
public CampaignResponse withTreatmentName(String treatmentName)
```
    The 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.
    
    Parameters:
    
    treatmentName - The 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Integer version)
```
    The version number of the campaign.
    
    Parameters:
    
    version - The version number of the campaign.
  - getVersion
```
public Integer getVersion()
```
    The version number of the campaign.
    
    Returns:
    
    The version number of the campaign.
  - withVersion
```
public CampaignResponse withVersion(Integer version)
```
    The version number of the campaign.
    
    Parameters:
    
    version - The version number of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
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.
    
    Parameters:
    
    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.
  - getPriority
```
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.
    
    Returns:
    
    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.
  - withPriority
```
public CampaignResponse 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.
    
    Parameters:
    
    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.
    
    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 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.

AWS SDK for Java 1.x API Reference - 1.12.779

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

setArn

getArn

withArn

setCreationDate

getCreationDate

withCreationDate

setCustomDeliveryConfiguration

getCustomDeliveryConfiguration

withCustomDeliveryConfiguration

setDefaultState

getDefaultState

withDefaultState

setDescription

getDescription

withDescription

setHoldoutPercent

getHoldoutPercent

withHoldoutPercent

setHook

getHook

withHook

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

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTreatmentDescription

getTreatmentDescription

withTreatmentDescription

setTreatmentName

getTreatmentName