Class TreatmentResource
- java.lang.Object
-
- software.amazon.awssdk.services.pinpoint.model.TreatmentResource
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<TreatmentResource.Builder,TreatmentResource>
@Generated("software.amazon.awssdk:codegen") public final class TreatmentResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TreatmentResource.Builder,TreatmentResource>
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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceTreatmentResource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TreatmentResource.Builderbuilder()CustomDeliveryConfigurationcustomDeliveryConfiguration()The delivery configuration settings for sending the treatment through a custom channel.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The unique identifier for the treatment.MessageConfigurationmessageConfiguration()The message configuration settings for the treatment.Scheduleschedule()The schedule settings for the treatment.List<SdkField<?>>sdkFields()static Class<? extends TreatmentResource.Builder>serializableBuilderClass()IntegersizePercent()The allocated percentage of users (segment members) that the treatment is sent to.CampaignStatestate()The current status of the treatment.TemplateConfigurationtemplateConfiguration()The message template to use for the treatment.TreatmentResource.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringtreatmentDescription()The custom description of the treatment.StringtreatmentName()The custom name of the treatment.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
customDeliveryConfiguration
public final 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.
- 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.
-
id
public final String id()
The unique identifier for the treatment.
- Returns:
- The unique identifier for the treatment.
-
messageConfiguration
public final MessageConfiguration messageConfiguration()
The message configuration settings for the treatment.
- Returns:
- The message configuration settings for the treatment.
-
schedule
public final Schedule schedule()
The schedule settings for the treatment.
- Returns:
- The schedule settings for the treatment.
-
sizePercent
public final Integer sizePercent()
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.
-
state
public final CampaignState state()
The current status of the treatment.
- Returns:
- The current status of the treatment.
-
templateConfiguration
public final TemplateConfiguration templateConfiguration()
The message template to use for the treatment.
- Returns:
- The message template to use for the treatment.
-
treatmentDescription
public final String treatmentDescription()
The custom description of the treatment.
- Returns:
- The custom description of the treatment.
-
treatmentName
public final String treatmentName()
The custom name of the treatment.
- Returns:
- The custom name of the treatment.
-
toBuilder
public TreatmentResource.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<TreatmentResource.Builder,TreatmentResource>
-
builder
public static TreatmentResource.Builder builder()
-
serializableBuilderClass
public static Class<? extends TreatmentResource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-