Package software.amazon.awssdk.services.pinpoint.model

Interface TreatmentResource.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TreatmentResource.Builder,TreatmentResource>, SdkBuilder<TreatmentResource.Builder,TreatmentResource>, SdkPojo

Enclosing class:

TreatmentResource

@Mutable
@NotThreadSafe
public static interface TreatmentResource.Builder
extends SdkPojo, CopyableBuilder<TreatmentResource.Builder,TreatmentResource>

Method Summary

Modifier and Type	Method	Description
default TreatmentResource.Builder	customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)	The delivery configuration settings for sending the treatment through a custom channel.
TreatmentResource.Builder	customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)	The delivery configuration settings for sending the treatment through a custom channel.
TreatmentResource.Builder	id(String id)	The unique identifier for the treatment.
default TreatmentResource.Builder	messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)	The message configuration settings for the treatment.
TreatmentResource.Builder	messageConfiguration(MessageConfiguration messageConfiguration)	The message configuration settings for the treatment.
default TreatmentResource.Builder	schedule(Consumer<Schedule.Builder> schedule)	The schedule settings for the treatment.
TreatmentResource.Builder	schedule(Schedule schedule)	The schedule settings for the treatment.
TreatmentResource.Builder	sizePercent(Integer sizePercent)	The allocated percentage of users (segment members) that the treatment is sent to.
default TreatmentResource.Builder	state(Consumer<CampaignState.Builder> state)	The current status of the treatment.
TreatmentResource.Builder	state(CampaignState state)	The current status of the treatment.
default TreatmentResource.Builder	templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)	The message template to use for the treatment.
TreatmentResource.Builder	templateConfiguration(TemplateConfiguration templateConfiguration)	The message template to use for the treatment.
TreatmentResource.Builder	treatmentDescription(String treatmentDescription)	The custom description of the treatment.
TreatmentResource.Builder	treatmentName(String treatmentName)	The custom name of the treatment.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

customDeliveryConfiguration

TreatmentResource.Builder customDeliveryConfiguration(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.

customDeliveryConfiguration

default TreatmentResource.Builder customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> 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.

This is a convenience method that creates an instance of the CustomDeliveryConfiguration.Builder avoiding the need to create one manually via CustomDeliveryConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDeliveryConfiguration(CustomDeliveryConfiguration).

Parameters:

customDeliveryConfiguration - a consumer that will call methods on CustomDeliveryConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customDeliveryConfiguration(CustomDeliveryConfiguration)

id

TreatmentResource.Builder id(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.

messageConfiguration

TreatmentResource.Builder messageConfiguration(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.

messageConfiguration

default TreatmentResource.Builder messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)

The message configuration settings for the treatment.

This is a convenience method that creates an instance of the MessageConfiguration.Builder avoiding the need to create one manually via MessageConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageConfiguration(MessageConfiguration).

Parameters:

messageConfiguration - a consumer that will call methods on MessageConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• messageConfiguration(MessageConfiguration)

schedule

TreatmentResource.Builder schedule(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.

schedule

default TreatmentResource.Builder schedule(Consumer<Schedule.Builder> schedule)

The schedule settings for the treatment.

This is a convenience method that creates an instance of the Schedule.Builder avoiding the need to create one manually via Schedule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(Schedule).

Parameters:

schedule - a consumer that will call methods on Schedule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• schedule(Schedule)

sizePercent

TreatmentResource.Builder sizePercent(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.

state

TreatmentResource.Builder state(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.

state

default TreatmentResource.Builder state(Consumer<CampaignState.Builder> state)

The current status of the treatment.

This is a convenience method that creates an instance of the CampaignState.Builder avoiding the need to create one manually via CampaignState.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(CampaignState).

Parameters:

state - a consumer that will call methods on CampaignState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• state(CampaignState)

templateConfiguration

TreatmentResource.Builder templateConfiguration(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.

templateConfiguration

default TreatmentResource.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)

The message template to use for the treatment.

This is a convenience method that creates an instance of the TemplateConfiguration.Builder avoiding the need to create one manually via TemplateConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to templateConfiguration(TemplateConfiguration).

Parameters:

templateConfiguration - a consumer that will call methods on TemplateConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• templateConfiguration(TemplateConfiguration)

treatmentDescription

TreatmentResource.Builder treatmentDescription(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.

treatmentName

TreatmentResource.Builder treatmentName(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.