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

Interface WriteCampaignRequest.Builder

All Superinterfaces:

CopyableBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>, SdkBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>

Enclosing class:

WriteCampaignRequest

public static interface WriteCampaignRequest.Builder
extends CopyableBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>

Method Summary

Modifier and Type	Method	Description
WriteCampaignRequest.Builder	additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)	Treatments that are defined in addition to the default treatment.
WriteCampaignRequest.Builder	additionalTreatments(WriteTreatmentResource... additionalTreatments)	Treatments that are defined in addition to the default treatment.
WriteCampaignRequest.Builder	description(String description)	A description of the campaign.
WriteCampaignRequest.Builder	holdoutPercent(Integer holdoutPercent)	The allocated percentage of end users who will not receive messages from this campaign.
WriteCampaignRequest.Builder	isPaused(Boolean isPaused)	Indicates whether the campaign is paused.
WriteCampaignRequest.Builder	limits(CampaignLimits limits)	The campaign limits settings.
WriteCampaignRequest.Builder	messageConfiguration(MessageConfiguration messageConfiguration)	The message configuration settings.
WriteCampaignRequest.Builder	name(String name)	The custom name of the campaign.
WriteCampaignRequest.Builder	schedule(Schedule schedule)	The campaign schedule.
WriteCampaignRequest.Builder	segmentId(String segmentId)	The ID of the segment to which the campaign sends messages.
WriteCampaignRequest.Builder	segmentVersion(Integer segmentVersion)	The version of the segment to which the campaign sends messages.
WriteCampaignRequest.Builder	treatmentDescription(String treatmentDescription)	A custom description for the treatment.
WriteCampaignRequest.Builder	treatmentName(String treatmentName)	The custom name of a variation of the campaign used for A/B testing.

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

copy

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

apply, build

Method Detail

additionalTreatments

WriteCampaignRequest.Builder additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)

Treatments that are defined in addition to the default treatment.

Parameters:

additionalTreatments - Treatments that are defined in addition to the default treatment.

Returns:

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

additionalTreatments

WriteCampaignRequest.Builder additionalTreatments(WriteTreatmentResource... additionalTreatments)

Treatments that are defined 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 - Treatments that are defined in addition to the default treatment.

Returns:

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

description

WriteCampaignRequest.Builder description(String description)

A description of the campaign.

Parameters:

description - A description of the campaign.

Returns:

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

holdoutPercent

WriteCampaignRequest.Builder holdoutPercent(Integer holdoutPercent)

The allocated percentage of end users who will not receive messages from this campaign.

Parameters:

holdoutPercent - The allocated percentage of end users who will not receive messages from this campaign.

Returns:

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

isPaused

WriteCampaignRequest.Builder isPaused(Boolean isPaused)

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

Parameters:

isPaused - Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

Returns:

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

limits

WriteCampaignRequest.Builder limits(CampaignLimits limits)

The campaign limits settings.

Parameters:

limits - The campaign limits settings.

Returns:

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

messageConfiguration

WriteCampaignRequest.Builder messageConfiguration(MessageConfiguration messageConfiguration)

The message configuration settings.

Parameters:

messageConfiguration - The message configuration settings.

Returns:

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

name

WriteCampaignRequest.Builder name(String name)

The custom name of the campaign.

Parameters:

name - The custom name of the campaign.

Returns:

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

schedule

WriteCampaignRequest.Builder schedule(Schedule schedule)

The campaign schedule.

Parameters:

schedule - The campaign schedule.

Returns:

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

segmentId

WriteCampaignRequest.Builder segmentId(String segmentId)

The ID of the segment to which the campaign sends messages.

Parameters:

segmentId - The ID of the segment to which the campaign sends messages.

Returns:

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

segmentVersion

WriteCampaignRequest.Builder segmentVersion(Integer segmentVersion)

The version of the segment to which the campaign sends messages.

Parameters:

segmentVersion - The version of the segment to which the campaign sends messages.

Returns:

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

treatmentDescription

WriteCampaignRequest.Builder treatmentDescription(String treatmentDescription)

A custom description for the treatment.

Parameters:

treatmentDescription - A custom description for the treatment.

Returns:

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

treatmentName

WriteCampaignRequest.Builder treatmentName(String treatmentName)

The custom name of a variation of the campaign used for A/B testing.

Parameters:

treatmentName - The custom name of a variation of the campaign used for A/B testing.

Returns:

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