CampaignResponse.Builder (AWS Java SDK :: Services

All Superinterfaces:

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

Enclosing class:

CampaignResponse
```
public static interface CampaignResponse.Builder
extends SdkPojo, CopyableBuilder<CampaignResponse.Builder,CampaignResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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, in ISO 8601 format, when the campaign was created.
`default CampaignResponse.Builder`	`customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)` The delivery configuration settings for sending the campaign through a custom channel.
`CampaignResponse.Builder`	`customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)` The delivery configuration settings for sending the campaign through a custom channel.
`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.
`default CampaignResponse.Builder`	`templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)` The message template that’s used for the campaign.
`CampaignResponse.Builder`	`templateConfiguration(TemplateConfiguration templateConfiguration)` The message template that’s used for the campaign.
`CampaignResponse.Builder`	`treatmentDescription(String treatmentDescription)` The custom description of the default treatment for the campaign.
`CampaignResponse.Builder`	`treatmentName(String treatmentName)` The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
`CampaignResponse.Builder`	`version(Integer version)` The version number of the campaign.

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
```
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.
    
    Parameters:
    
    additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalTreatments
```
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.
    
    Parameters:
    
    additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalTreatments
```
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 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)
  - applicationId
```
CampaignResponse.Builder applicationId(String applicationId)
```
    The unique identifier for the application that the campaign applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - arn
```
CampaignResponse.Builder arn(String arn)
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - creationDate
```
CampaignResponse.Builder creationDate(String creationDate)
```
    The date, in ISO 8601 format, when the campaign was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the campaign was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - customDeliveryConfiguration
```
CampaignResponse.Builder customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)
```
    The delivery configuration settings for sending the campaign through a custom channel.
    
    Parameters:
    
    customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - customDeliveryConfiguration
```
default CampaignResponse.Builder customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)
```
    The delivery configuration settings for sending the campaign through a custom channel.
    This is a convenience that creates an instance of the CustomDeliveryConfiguration.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).
    
    Parameters:
    
    customDeliveryConfiguration - a consumer that will call methods on CustomDeliveryConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    customDeliveryConfiguration(CustomDeliveryConfiguration)
  - defaultState
```
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.
    
    Parameters:
    
    defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - defaultState
```
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.
    This is a convenience that creates an instance of the CampaignState.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).
    
    Parameters:
    
    defaultState - a consumer that will call methods on CampaignState.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    defaultState(CampaignState)
  - description
```
CampaignResponse.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
```
CampaignResponse.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
```
CampaignResponse.Builder hook(CampaignHook hook)
```
    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
    
    Parameters:
    
    hook - The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - hook
```
default CampaignResponse.Builder hook(Consumer<CampaignHook.Builder> hook)
```
    The settings for the AWS Lambda function to use 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 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)
  - id
```
CampaignResponse.Builder id(String id)
```
    The unique identifier for the campaign.
    
    Parameters:
    
    id - The unique identifier for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPaused
```
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.
    
    Parameters:
    
    isPaused - Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastModifiedDate
```
CampaignResponse.Builder lastModifiedDate(String lastModifiedDate)
```
    The date, in ISO 8601 format, when the campaign was last modified.
    
    Parameters:
    
    lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - limits
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.Builder name(String name)
```
    The name of the campaign.
    
    Parameters:
    
    name - The name of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedule
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.Builder segmentId(String segmentId)
```
    The unique identifier for the segment that's associated with the campaign.
    
    Parameters:
    
    segmentId - The unique identifier for the segment that's associated with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - segmentVersion
```
CampaignResponse.Builder segmentVersion(Integer segmentVersion)
```
    The version number of the segment that's associated with the campaign.
    
    Parameters:
    
    segmentVersion - The version number of the segment that's associated with the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - state
```
CampaignResponse.Builder state(CampaignState state)
```
    The current status of the campaign.
    
    Parameters:
    
    state - The current status of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - state
```
default CampaignResponse.Builder state(Consumer<CampaignState.Builder> state)
```
    The current status of the campaign.
    This is a convenience that creates an instance of the CampaignState.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).
    
    Parameters:
    
    state - a consumer that will call methods on CampaignState.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    state(CampaignState)
  - tags
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - templateConfiguration
```
CampaignResponse.Builder templateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template that’s used for the campaign.
    
    Parameters:
    
    templateConfiguration - The message template that’s used for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - templateConfiguration
```
default CampaignResponse.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)
```
    The message template that’s used for the campaign.
    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
```
CampaignResponse.Builder treatmentDescription(String treatmentDescription)
```
    The custom description of the default treatment for the campaign.
    
    Parameters:
    
    treatmentDescription - The custom description of the default treatment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - treatmentName
```
CampaignResponse.Builder treatmentName(String treatmentName)
```
    The 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.
    
    Parameters:
    
    treatmentName - The 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - version
```
CampaignResponse.Builder version(Integer version)
```
    The version number of the campaign.
    
    Parameters:
    
    version - The version number of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface CampaignResponse.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

applicationId

arn

creationDate

customDeliveryConfiguration

customDeliveryConfiguration

defaultState

defaultState

description

holdoutPercent

hook

hook

id

isPaused

lastModifiedDate

limits

limits

messageConfiguration

messageConfiguration

name

schedule

schedule

segmentId

segmentVersion

state

state

tags

templateConfiguration

templateConfiguration

treatmentDescription

treatmentName

version