software.amazon.awssdk.services.pinpoint.model

Interface WriteCampaignRequest.Builder

All Superinterfaces:

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

Enclosing class:

WriteCampaignRequest

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

Method Summary

Modifier and Type	Method and Description
WriteCampaignRequest.Builder	additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments) Treatments that are defined in addition to the default treatment.
WriteCampaignRequest.Builder	additionalTreatments(Consumer<WriteTreatmentResource.Builder>... 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	hook(CampaignHook hook) Campaign hook information.
default WriteCampaignRequest.Builder	hook(Consumer<CampaignHook.Builder> hook) Campaign hook information.
WriteCampaignRequest.Builder	isPaused(Boolean isPaused) Indicates whether the campaign is paused.
WriteCampaignRequest.Builder	limits(CampaignLimits limits) The campaign limits settings.
default WriteCampaignRequest.Builder	limits(Consumer<CampaignLimits.Builder> limits) The campaign limits settings.
default WriteCampaignRequest.Builder	messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration) The message configuration settings.
WriteCampaignRequest.Builder	messageConfiguration(MessageConfiguration messageConfiguration) The message configuration settings.
WriteCampaignRequest.Builder	name(String name) The custom name of the campaign.
default WriteCampaignRequest.Builder	schedule(Consumer<Schedule.Builder> schedule) The campaign schedule.
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.core.SdkPojo

sdkFields

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

copy

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

applyMutation, 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.

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(Consumer<WriteTreatmentResource.Builder>... additionalTreatments)

Treatments that are defined in addition to the default treatment. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #additionalTreatments(List).

Parameters:

additionalTreatments - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#additionalTreatments(List)

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.

hook

WriteCampaignRequest.Builder hook(CampaignHook hook)

Campaign hook information.

Parameters:

hook - Campaign hook information.

Returns:

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

hook

default WriteCampaignRequest.Builder hook(Consumer<CampaignHook.Builder> hook)

Campaign hook information. This is a convenience that creates an instance of the CampaignHook.Builder avoiding the need to create one manually via CampaignHook.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hook(CampaignHook).

Parameters:

hook - a consumer that will call methods on CampaignHook.Builder

Returns:

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

See Also:

hook(CampaignHook)

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.

limits

default WriteCampaignRequest.Builder limits(Consumer<CampaignLimits.Builder> limits)

The campaign limits settings. This is a convenience that creates an instance of the CampaignLimits.Builder avoiding the need to create one manually via CampaignLimits.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to limits(CampaignLimits).

Parameters:

limits - a consumer that will call methods on CampaignLimits.Builder

Returns:

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

See Also:

limits(CampaignLimits)

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.

messageConfiguration

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

The message configuration settings. This is a convenience 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)

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.

schedule

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

The campaign schedule. This is a convenience 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)

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.