WriteCampaignRequest.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
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.
`WriteCampaignRequest.Builder`	`description(String description)` The 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 use as a code hook for the campaign.
`default WriteCampaignRequest.Builder`	`hook(Consumer<CampaignHook.Builder> hook)` The settings for the AWS Lambda function to use 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)` The custom name of 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)` Sets the value of the TemplateConfiguration property for this object.
`WriteCampaignRequest.Builder`	`templateConfiguration(TemplateConfiguration templateConfiguration)` Sets the value of the TemplateConfiguration property for this object.
`WriteCampaignRequest.Builder`	`treatmentDescription(String treatmentDescription)` The custom description of a variation of the campaign to use for A/B testing.
`WriteCampaignRequest.Builder`	`treatmentName(String treatmentName)` The custom name of a variation of the campaign to use for A/B testing.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, 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)
```
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Parameters:
    
    additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalTreatments
```
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.
    
    Parameters:
    
    additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalTreatments
```
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 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)
```
    The custom description of the campaign.
    
    Parameters:
    
    description - The custom 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 users (segment members) who shouldn't receive messages from the campaign.
    
    Parameters:
    
    holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - hook
```
WriteCampaignRequest.Builder hook(CampaignHook hook)
```
    The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - hook
```
default WriteCampaignRequest.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 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)
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Parameters:
    
    isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - limits
```
WriteCampaignRequest.Builder limits(CampaignLimits limits)
```
    The messaging limits for the campaign.
    
    Parameters:
    
    limits - The messaging limits for the campaign.
    
    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 messaging limits for the campaign.
    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 for the campaign.
    
    Parameters:
    
    messageConfiguration - The message configuration settings for the campaign.
    
    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 for the campaign.
    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 schedule settings for the campaign.
    
    Parameters:
    
    schedule - The schedule settings for the campaign.
    
    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 schedule settings for the campaign.
    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 unique identifier for the segment to associate with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment to associate with the campaign.
    
    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 associate with the campaign.
    
    Parameters:
    
    segmentVersion - The version of the segment to associate with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - templateConfiguration
```
WriteCampaignRequest.Builder templateConfiguration(TemplateConfiguration templateConfiguration)
```
    Sets the value of the TemplateConfiguration property for this object.
    
    Parameters:
    
    templateConfiguration - The new value for the TemplateConfiguration property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - templateConfiguration
```
default WriteCampaignRequest.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)
```
    Sets the value of the TemplateConfiguration property for this object. This is a convenience 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
```
WriteCampaignRequest.Builder treatmentDescription(String treatmentDescription)
```
    The custom description of a variation of the campaign to use for A/B testing.
    
    Parameters:
    
    treatmentDescription - The custom description of a variation of the campaign to use for A/B testing.
    
    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 to use for A/B testing.
    
    Parameters:
    
    treatmentName - The custom name of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface WriteCampaignRequest.Builder

Method Summary

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

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

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

Method Detail

additionalTreatments

additionalTreatments

additionalTreatments

description

holdoutPercent

hook

hook

isPaused

limits

limits

messageConfiguration

messageConfiguration

name

schedule

schedule

segmentId

segmentVersion

tags

templateConfiguration

templateConfiguration

treatmentDescription

treatmentName