TreatmentResource (AWS Java SDK for Amazon Pinpoint 1.12.38 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TreatmentResource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TreatmentResource()

Constructors
Constructor and Description
`TreatmentResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TreatmentResource`	`clone()`
`boolean`	`equals(Object obj)`
`CustomDeliveryConfiguration`	`getCustomDeliveryConfiguration()` The delivery configuration settings for sending the treatment through a custom channel.
`String`	`getId()` The unique identifier for the treatment.
`MessageConfiguration`	`getMessageConfiguration()` The message configuration settings for the treatment.
`Schedule`	`getSchedule()` The schedule settings for the treatment.
`Integer`	`getSizePercent()` The allocated percentage of users (segment members) that the treatment is sent to.
`CampaignState`	`getState()` The current status of the treatment.
`TemplateConfiguration`	`getTemplateConfiguration()` The message template to use for the treatment.
`String`	`getTreatmentDescription()` The custom description of the treatment.
`String`	`getTreatmentName()` The custom name of the treatment.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)` The delivery configuration settings for sending the treatment through a custom channel.
`void`	`setId(String id)` The unique identifier for the treatment.
`void`	`setMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings for the treatment.
`void`	`setSchedule(Schedule schedule)` The schedule settings for the treatment.
`void`	`setSizePercent(Integer sizePercent)` The allocated percentage of users (segment members) that the treatment is sent to.
`void`	`setState(CampaignState state)` The current status of the treatment.
`void`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template to use for the treatment.
`void`	`setTreatmentDescription(String treatmentDescription)` The custom description of the treatment.
`void`	`setTreatmentName(String treatmentName)` The custom name of the treatment.
`String`	`toString()` Returns a string representation of this object.
`TreatmentResource`	`withCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)` The delivery configuration settings for sending the treatment through a custom channel.
`TreatmentResource`	`withId(String id)` The unique identifier for the treatment.
`TreatmentResource`	`withMessageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings for the treatment.
`TreatmentResource`	`withSchedule(Schedule schedule)` The schedule settings for the treatment.
`TreatmentResource`	`withSizePercent(Integer sizePercent)` The allocated percentage of users (segment members) that the treatment is sent to.
`TreatmentResource`	`withState(CampaignState state)` The current status of the treatment.
`TreatmentResource`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template to use for the treatment.
`TreatmentResource`	`withTreatmentDescription(String treatmentDescription)` The custom description of the treatment.
`TreatmentResource`	`withTreatmentName(String treatmentName)` The custom name of the treatment.

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

- Constructor Detail
  - TreatmentResource
```
public TreatmentResource()
```
- Method Detail
  - setCustomDeliveryConfiguration
```
public void setCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
```
    The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
    
    Parameters:
    
    customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
  - getCustomDeliveryConfiguration
```
public CustomDeliveryConfiguration getCustomDeliveryConfiguration()
```
    The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
    
    Returns:
    
    The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
  - withCustomDeliveryConfiguration
```
public TreatmentResource withCustomDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
```
    The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
    
    Parameters:
    
    customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
    
    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 treatment.
    
    Parameters:
    
    id - The unique identifier for the treatment.
  - getId
```
public String getId()
```
    The unique identifier for the treatment.
    
    Returns:
    
    The unique identifier for the treatment.
  - withId
```
public TreatmentResource withId(String id)
```
    The unique identifier for the treatment.
    
    Parameters:
    
    id - The unique identifier for the treatment.
    
    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 treatment.
    
    Parameters:
    
    messageConfiguration - The message configuration settings for the treatment.
  - getMessageConfiguration
```
public MessageConfiguration getMessageConfiguration()
```
    The message configuration settings for the treatment.
    
    Returns:
    
    The message configuration settings for the treatment.
  - withMessageConfiguration
```
public TreatmentResource withMessageConfiguration(MessageConfiguration messageConfiguration)
```
    The message configuration settings for the treatment.
    
    Parameters:
    
    messageConfiguration - The message configuration settings for the treatment.
    
    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 treatment.
    
    Parameters:
    
    schedule - The schedule settings for the treatment.
  - getSchedule
```
public Schedule getSchedule()
```
    The schedule settings for the treatment.
    
    Returns:
    
    The schedule settings for the treatment.
  - withSchedule
```
public TreatmentResource withSchedule(Schedule schedule)
```
    The schedule settings for the treatment.
    
    Parameters:
    
    schedule - The schedule settings for the treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizePercent
```
public void setSizePercent(Integer sizePercent)
```
    The allocated percentage of users (segment members) that the treatment is sent to.
    
    Parameters:
    
    sizePercent - The allocated percentage of users (segment members) that the treatment is sent to.
  - getSizePercent
```
public Integer getSizePercent()
```
    The allocated percentage of users (segment members) that the treatment is sent to.
    
    Returns:
    
    The allocated percentage of users (segment members) that the treatment is sent to.
  - withSizePercent
```
public TreatmentResource withSizePercent(Integer sizePercent)
```
    The allocated percentage of users (segment members) that the treatment is sent to.
    
    Parameters:
    
    sizePercent - The allocated percentage of users (segment members) that the treatment is sent to.
    
    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 treatment.
    
    Parameters:
    
    state - The current status of the treatment.
  - getState
```
public CampaignState getState()
```
    The current status of the treatment.
    
    Returns:
    
    The current status of the treatment.
  - withState
```
public TreatmentResource withState(CampaignState state)
```
    The current status of the treatment.
    
    Parameters:
    
    state - The current status of the treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateConfiguration
```
public void setTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template to use for the treatment.
    
    Parameters:
    
    templateConfiguration - The message template to use for the treatment.
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    The message template to use for the treatment.
    
    Returns:
    
    The message template to use for the treatment.
  - withTemplateConfiguration
```
public TreatmentResource withTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template to use for the treatment.
    
    Parameters:
    
    templateConfiguration - The message template to use for the treatment.
    
    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 treatment.
    
    Parameters:
    
    treatmentDescription - The custom description of the treatment.
  - getTreatmentDescription
```
public String getTreatmentDescription()
```
    The custom description of the treatment.
    
    Returns:
    
    The custom description of the treatment.
  - withTreatmentDescription
```
public TreatmentResource withTreatmentDescription(String treatmentDescription)
```
    The custom description of the treatment.
    
    Parameters:
    
    treatmentDescription - The custom description of 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 the treatment.
    
    Parameters:
    
    treatmentName - The custom name of the treatment.
  - getTreatmentName
```
public String getTreatmentName()
```
    The custom name of the treatment.
    
    Returns:
    
    The custom name of the treatment.
  - withTreatmentName
```
public TreatmentResource withTreatmentName(String treatmentName)
```
    The custom name of the treatment.
    
    Parameters:
    
    treatmentName - The custom name of the treatment.
    
    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 TreatmentResource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TreatmentResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreatmentResource

Method Detail

setCustomDeliveryConfiguration

getCustomDeliveryConfiguration

withCustomDeliveryConfiguration

setId

getId

withId

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setSchedule

getSchedule

withSchedule

setSizePercent

getSizePercent

withSizePercent

setState

getState

withState

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTreatmentDescription

getTreatmentDescription

withTreatmentDescription

setTreatmentName

getTreatmentName

withTreatmentName

toString

equals

hashCode

clone

marshall