public static interface WriteCampaignRequest.Builder extends SdkPojo, CopyableBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>
| Modifier and Type | Method and Description |
|---|---|
WriteCampaignRequest.Builder |
additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.
|
WriteCampaignRequest.Builder |
additionalTreatments(Consumer<WriteTreatmentResource.Builder>... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.
|
WriteCampaignRequest.Builder |
additionalTreatments(WriteTreatmentResource... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.
|
default WriteCampaignRequest.Builder |
customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel.
|
WriteCampaignRequest.Builder |
customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel.
|
WriteCampaignRequest.Builder |
description(String description)
A custom description of the campaign.
|
WriteCampaignRequest.Builder |
holdoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
WriteCampaignRequest.Builder |
hook(CampaignHook hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
|
default WriteCampaignRequest.Builder |
hook(Consumer<CampaignHook.Builder> hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign.
|
WriteCampaignRequest.Builder |
isPaused(Boolean isPaused)
Specifies whether to pause the campaign.
|
WriteCampaignRequest.Builder |
limits(CampaignLimits limits)
The messaging limits for the campaign.
|
default WriteCampaignRequest.Builder |
limits(Consumer<CampaignLimits.Builder> limits)
The messaging limits for the campaign.
|
default WriteCampaignRequest.Builder |
messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)
The message configuration settings for the campaign.
|
WriteCampaignRequest.Builder |
messageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
|
WriteCampaignRequest.Builder |
name(String name)
A custom name for the campaign.
|
default WriteCampaignRequest.Builder |
schedule(Consumer<Schedule.Builder> schedule)
The schedule settings for the campaign.
|
WriteCampaignRequest.Builder |
schedule(Schedule schedule)
The schedule settings for the campaign.
|
WriteCampaignRequest.Builder |
segmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
|
WriteCampaignRequest.Builder |
segmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
|
WriteCampaignRequest.Builder |
tags(Map<String,String> tags)
A string-to-string map of key-value pairs that defines the tags to associate with the campaign.
|
default WriteCampaignRequest.Builder |
templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)
The message template to use for the campaign.
|
WriteCampaignRequest.Builder |
templateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
|
WriteCampaignRequest.Builder |
treatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
|
WriteCampaignRequest.Builder |
treatmentName(String treatmentName)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildWriteCampaignRequest.Builder additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.WriteCampaignRequest.Builder additionalTreatments(WriteTreatmentResource... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default
treatment for the campaign.WriteCampaignRequest.Builder additionalTreatments(Consumer<WriteTreatmentResource.Builder>... additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
This is a convenience that creates an instance of theList.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) .additionalTreatments - a consumer that will call methods on List.Builder #additionalTreatments(List) WriteCampaignRequest.Builder customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel. This object is
required if the MessageConfiguration object for the campaign specifies a CustomMessage object.default WriteCampaignRequest.Builder customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
This is a convenience that creates an instance of theCustomDeliveryConfiguration.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).customDeliveryConfiguration - a consumer that will call methods on CustomDeliveryConfiguration.BuildercustomDeliveryConfiguration(CustomDeliveryConfiguration)WriteCampaignRequest.Builder description(String description)
A custom description of the campaign.
description - A custom description of the campaign.WriteCampaignRequest.Builder holdoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.WriteCampaignRequest.Builder hook(CampaignHook hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
hook - The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this
hook to customize the segment that's used by the campaign.default WriteCampaignRequest.Builder hook(Consumer<CampaignHook.Builder> hook)
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
This is a convenience that creates an instance of theCampaignHook.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).hook - a consumer that will call methods on CampaignHook.Builderhook(CampaignHook)WriteCampaignRequest.Builder isPaused(Boolean isPaused)
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by
changing this value to false.WriteCampaignRequest.Builder limits(CampaignLimits limits)
The messaging limits for the campaign.
limits - The messaging limits for the campaign.default WriteCampaignRequest.Builder limits(Consumer<CampaignLimits.Builder> limits)
The messaging limits for the campaign.
This is a convenience that creates an instance of theCampaignLimits.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).limits - a consumer that will call methods on CampaignLimits.Builderlimits(CampaignLimits)WriteCampaignRequest.Builder messageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
messageConfiguration - The message configuration settings for the campaign.default WriteCampaignRequest.Builder messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)
The message configuration settings for the campaign.
This is a convenience that creates an instance of theMessageConfiguration.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).messageConfiguration - a consumer that will call methods on MessageConfiguration.BuildermessageConfiguration(MessageConfiguration)WriteCampaignRequest.Builder name(String name)
A custom name for the campaign.
name - A custom name for the campaign.WriteCampaignRequest.Builder schedule(Schedule schedule)
The schedule settings for the campaign.
schedule - The schedule settings for the campaign.default WriteCampaignRequest.Builder schedule(Consumer<Schedule.Builder> schedule)
The schedule settings for the campaign.
This is a convenience that creates an instance of theSchedule.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).schedule - a consumer that will call methods on Schedule.Builderschedule(Schedule)WriteCampaignRequest.Builder segmentId(String segmentId)
The unique identifier for the segment to associate with the campaign.
segmentId - The unique identifier for the segment to associate with the campaign.WriteCampaignRequest.Builder segmentVersion(Integer segmentVersion)
The version of the segment to associate with the campaign.
segmentVersion - The version of the segment to associate with the campaign.WriteCampaignRequest.Builder tags(Map<String,String> tags)
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
tags - A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each
tag consists of a required tag key and an associated tag value.WriteCampaignRequest.Builder templateConfiguration(TemplateConfiguration templateConfiguration)
The message template to use for the campaign.
templateConfiguration - The message template to use for the campaign.default WriteCampaignRequest.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)
The message template to use for the campaign.
This is a convenience that creates an instance of theTemplateConfiguration.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).templateConfiguration - a consumer that will call methods on TemplateConfiguration.BuildertemplateConfiguration(TemplateConfiguration)WriteCampaignRequest.Builder treatmentDescription(String treatmentDescription)
A custom description of the default treatment for the campaign.
treatmentDescription - A custom description of the default treatment for the campaign.WriteCampaignRequest.Builder treatmentName(String treatmentName)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
treatmentName - A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A
treatment is a variation of a campaign that's used for A/B testing.Copyright © 2020. All rights reserved.