public static interface CampaignResponse.Builder extends SdkPojo, CopyableBuilder<CampaignResponse.Builder,CampaignResponse>
Modifier and Type | Method and Description |
---|---|
CampaignResponse.Builder |
additionalTreatments(Collection<TreatmentResource> additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default
treatment.
|
CampaignResponse.Builder |
additionalTreatments(Consumer<TreatmentResource.Builder>... additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default
treatment.
|
CampaignResponse.Builder |
additionalTreatments(TreatmentResource... additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default
treatment.
|
CampaignResponse.Builder |
applicationId(String applicationId)
The unique identifier for the application that the campaign applies to.
|
CampaignResponse.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the campaign.
|
CampaignResponse.Builder |
creationDate(String creationDate)
The date, ISO 8601 format, when the campaign was created.
|
CampaignResponse.Builder |
defaultState(CampaignState defaultState)
The current status of the campaign's default treatment.
|
default CampaignResponse.Builder |
defaultState(Consumer<CampaignState.Builder> defaultState)
The current status of the campaign's default treatment.
|
CampaignResponse.Builder |
description(String description)
The custom description of the campaign.
|
CampaignResponse.Builder |
holdoutPercent(Integer holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
CampaignResponse.Builder |
hook(CampaignHook hook)
The settings for the AWS Lambda function to use as a code hook for the campaign.
|
default CampaignResponse.Builder |
hook(Consumer<CampaignHook.Builder> hook)
The settings for the AWS Lambda function to use as a code hook for the campaign.
|
CampaignResponse.Builder |
id(String id)
The unique identifier for the campaign.
|
CampaignResponse.Builder |
isPaused(Boolean isPaused)
Specifies whether the campaign is paused.
|
CampaignResponse.Builder |
lastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the campaign was last modified.
|
CampaignResponse.Builder |
limits(CampaignLimits limits)
The messaging limits for the campaign.
|
default CampaignResponse.Builder |
limits(Consumer<CampaignLimits.Builder> limits)
The messaging limits for the campaign.
|
default CampaignResponse.Builder |
messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)
The message configuration settings for the campaign.
|
CampaignResponse.Builder |
messageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
|
CampaignResponse.Builder |
name(String name)
The name of the campaign.
|
default CampaignResponse.Builder |
schedule(Consumer<Schedule.Builder> schedule)
The schedule settings for the campaign.
|
CampaignResponse.Builder |
schedule(Schedule schedule)
The schedule settings for the campaign.
|
CampaignResponse.Builder |
segmentId(String segmentId)
The unique identifier for the segment that's associated with the campaign.
|
CampaignResponse.Builder |
segmentVersion(Integer segmentVersion)
The version number of the segment that's associated with the campaign.
|
CampaignResponse.Builder |
state(CampaignState state)
The current status of the campaign.
|
default CampaignResponse.Builder |
state(Consumer<CampaignState.Builder> state)
The current status of the campaign.
|
CampaignResponse.Builder |
tags(Map<String,String> tags)
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
|
CampaignResponse.Builder |
treatmentDescription(String treatmentDescription)
The custom description of a variation of the campaign that's used for A/B testing.
|
CampaignResponse.Builder |
treatmentName(String treatmentName)
The custom name of a variation of the campaign that's used for A/B testing.
|
CampaignResponse.Builder |
version(Integer version)
The version number of the campaign.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
CampaignResponse.Builder additionalTreatments(Collection<TreatmentResource> additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
additionalTreatments
- An array of responses, one for each treatment that you defined for the campaign, in addition to the
default treatment.CampaignResponse.Builder additionalTreatments(TreatmentResource... additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
additionalTreatments
- An array of responses, one for each treatment that you defined for the campaign, in addition to the
default treatment.CampaignResponse.Builder additionalTreatments(Consumer<TreatmentResource.Builder>... additionalTreatments)
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
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)
CampaignResponse.Builder applicationId(String applicationId)
The unique identifier for the application that the campaign applies to.
applicationId
- The unique identifier for the application that the campaign applies to.CampaignResponse.Builder arn(String arn)
The Amazon Resource Name (ARN) of the campaign.
arn
- The Amazon Resource Name (ARN) of the campaign.CampaignResponse.Builder creationDate(String creationDate)
The date, ISO 8601 format, when the campaign was created.
creationDate
- The date, ISO 8601 format, when the campaign was created.CampaignResponse.Builder defaultState(CampaignState defaultState)
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
defaultState
- The current status of the campaign's default treatment. This value exists only for campaigns that have
more than one treatment, to support A/B testing.default CampaignResponse.Builder defaultState(Consumer<CampaignState.Builder> defaultState)
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
This is a convenience that creates an instance of theCampaignState.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 defaultState(CampaignState)
.defaultState
- a consumer that will call methods on CampaignState.Builder
defaultState(CampaignState)
CampaignResponse.Builder description(String description)
The custom description of the campaign.
description
- The custom description of the campaign.CampaignResponse.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.CampaignResponse.Builder hook(CampaignHook hook)
The settings for the AWS Lambda function to use as a code hook for the campaign.
hook
- The settings for the AWS Lambda function to use as a code hook for the campaign.default CampaignResponse.Builder hook(Consumer<CampaignHook.Builder> hook)
The settings for the AWS Lambda function to use as a code hook for 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.Builder
hook(CampaignHook)
CampaignResponse.Builder id(String id)
The unique identifier for the campaign.
id
- The unique identifier for the campaign.CampaignResponse.Builder isPaused(Boolean isPaused)
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
isPaused
- Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by
changing this value to false.CampaignResponse.Builder lastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the campaign was last modified.
lastModifiedDate
- The date, in ISO 8601 format, when the campaign was last modified.CampaignResponse.Builder limits(CampaignLimits limits)
The messaging limits for the campaign.
limits
- The messaging limits for the campaign.default CampaignResponse.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.Builder
limits(CampaignLimits)
CampaignResponse.Builder messageConfiguration(MessageConfiguration messageConfiguration)
The message configuration settings for the campaign.
messageConfiguration
- The message configuration settings for the campaign.default CampaignResponse.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.Builder
messageConfiguration(MessageConfiguration)
CampaignResponse.Builder name(String name)
The name of the campaign.
name
- The name of the campaign.CampaignResponse.Builder schedule(Schedule schedule)
The schedule settings for the campaign.
schedule
- The schedule settings for the campaign.default CampaignResponse.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.Builder
schedule(Schedule)
CampaignResponse.Builder segmentId(String segmentId)
The unique identifier for the segment that's associated with the campaign.
segmentId
- The unique identifier for the segment that's associated with the campaign.CampaignResponse.Builder segmentVersion(Integer segmentVersion)
The version number of the segment that's associated with the campaign.
segmentVersion
- The version number of the segment that's associated with the campaign.CampaignResponse.Builder state(CampaignState state)
The current status of the campaign.
state
- The current status of the campaign.default CampaignResponse.Builder state(Consumer<CampaignState.Builder> state)
The current status of the campaign.
This is a convenience that creates an instance of theCampaignState.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)
.state
- a consumer that will call methods on CampaignState.Builder
state(CampaignState)
CampaignResponse.Builder tags(Map<String,String> tags)
A string-to-string map of key-value pairs that identifies the tags that are associated 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 identifies the tags that are associated with the
campaign. Each tag consists of a required tag key and an associated tag value.CampaignResponse.Builder treatmentDescription(String treatmentDescription)
The custom description of a variation of the campaign that's used for A/B testing.
treatmentDescription
- The custom description of a variation of the campaign that's used for A/B testing.CampaignResponse.Builder treatmentName(String treatmentName)
The custom name of a variation of the campaign that's used for A/B testing.
treatmentName
- The custom name of a variation of the campaign that's used for A/B testing.CampaignResponse.Builder version(Integer version)
The version number of the campaign.
version
- The version number of the campaign.Copyright © 2019. All rights reserved.