software.amazon.awssdk.services.pinpoint.model

Class TreatmentResource

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.TreatmentResource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TreatmentResource.Builder,TreatmentResource>

@Generated(value="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 and Description
static interface	TreatmentResource.Builder

Method Summary

Modifier and Type	Method and Description
static TreatmentResource.Builder	builder()
CustomDeliveryConfiguration	customDeliveryConfiguration() The delivery configuration settings for sending the treatment through a custom channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique identifier for the treatment.
MessageConfiguration	messageConfiguration() The message configuration settings for the treatment.
Schedule	schedule() The schedule settings for the treatment.
List<SdkField<?>>	sdkFields()
static Class<? extends TreatmentResource.Builder>	serializableBuilderClass()
Integer	sizePercent() The allocated percentage of users (segment members) that the treatment is sent to.
CampaignState	state() The current status of the treatment.
TemplateConfiguration	templateConfiguration() The message template to use for the treatment.
TreatmentResource.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	treatmentDescription() The custom description of the treatment.
String	treatmentName() 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:

toBuilder in interface ToCopyableBuilder<TreatmentResource.Builder,TreatmentResource>

builder

public static TreatmentResource.Builder builder()

serializableBuilderClass

public static Class<? extends TreatmentResource.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo