CampaignResponse.Builder (AWS SDK for Java

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)` Treatments that are defined in addition to the default treatment.
`CampaignResponse.Builder`	`additionalTreatments(Consumer<TreatmentResource.Builder>... additionalTreatments)` Treatments that are defined in addition to the default treatment.
`CampaignResponse.Builder`	`additionalTreatments(TreatmentResource... additionalTreatments)` Treatments that are defined in addition to the default treatment.
`CampaignResponse.Builder`	`applicationId(String applicationId)` The ID of the application to which the campaign applies.
`CampaignResponse.Builder`	`creationDate(String creationDate)` The date the campaign was created in ISO 8601 format.
`CampaignResponse.Builder`	`defaultState(CampaignState defaultState)` The status of the campaign's default treatment.
`default CampaignResponse.Builder`	`defaultState(Consumer<CampaignState.Builder> defaultState)` The status of the campaign's default treatment.
`CampaignResponse.Builder`	`description(String description)` A description of the campaign.
`CampaignResponse.Builder`	`holdoutPercent(Integer holdoutPercent)` The allocated percentage of end users who will not receive messages from this campaign.
`CampaignResponse.Builder`	`hook(CampaignHook hook)` Campaign hook information.
`default CampaignResponse.Builder`	`hook(Consumer<CampaignHook.Builder> hook)` Campaign hook information.
`CampaignResponse.Builder`	`id(String id)` The unique campaign ID.
`CampaignResponse.Builder`	`isPaused(Boolean isPaused)` Indicates whether the campaign is paused.
`CampaignResponse.Builder`	`lastModifiedDate(String lastModifiedDate)` The date the campaign was last updated in ISO 8601 format.
`CampaignResponse.Builder`	`limits(CampaignLimits limits)` The campaign limits settings.
`default CampaignResponse.Builder`	`limits(Consumer<CampaignLimits.Builder> limits)` The campaign limits settings.
`default CampaignResponse.Builder`	`messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)` The message configuration settings.
`CampaignResponse.Builder`	`messageConfiguration(MessageConfiguration messageConfiguration)` The message configuration settings.
`CampaignResponse.Builder`	`name(String name)` The custom name of the campaign.
`default CampaignResponse.Builder`	`schedule(Consumer<Schedule.Builder> schedule)` The campaign schedule.
`CampaignResponse.Builder`	`schedule(Schedule schedule)` The campaign schedule.
`CampaignResponse.Builder`	`segmentId(String segmentId)` The ID of the segment to which the campaign sends messages.
`CampaignResponse.Builder`	`segmentVersion(Integer segmentVersion)` The version of the segment to which the campaign sends messages.
`CampaignResponse.Builder`	`state(CampaignState state)` The campaign status.
`default CampaignResponse.Builder`	`state(Consumer<CampaignState.Builder> state)` The campaign status.
`CampaignResponse.Builder`	`treatmentDescription(String treatmentDescription)` A custom description for the treatment.
`CampaignResponse.Builder`	`treatmentName(String treatmentName)` The custom name of a variation of the campaign used for A/B testing.
`CampaignResponse.Builder`	`version(Integer version)` The campaign version number.

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
```
CampaignResponse.Builder additionalTreatments(Collection<TreatmentResource> 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
```
CampaignResponse.Builder additionalTreatments(TreatmentResource... 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
```
CampaignResponse.Builder additionalTreatments(Consumer<TreatmentResource.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)
  - applicationId
```
CampaignResponse.Builder applicationId(String applicationId)
```
    The ID of the application to which the campaign applies.
    
    Parameters:
    
    applicationId - The ID of the application to which the campaign applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - creationDate
```
CampaignResponse.Builder creationDate(String creationDate)
```
    The date the campaign was created in ISO 8601 format.
    
    Parameters:
    
    creationDate - The date the campaign was created in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - defaultState
```
CampaignResponse.Builder defaultState(CampaignState defaultState)
```
    The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    Parameters:
    
    defaultState - The status of the campaign's default treatment. Only present for A/B test campaigns.
    
    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 status of the campaign's default treatment. Only present for A/B test campaigns. 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)
```
    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
```
CampaignResponse.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
```
CampaignResponse.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 CampaignResponse.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)
  - id
```
CampaignResponse.Builder id(String id)
```
    The unique campaign ID.
    
    Parameters:
    
    id - The unique campaign ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPaused
```
CampaignResponse.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.
  - lastModifiedDate
```
CampaignResponse.Builder lastModifiedDate(String lastModifiedDate)
```
    The date the campaign was last updated in ISO 8601 format.
    
    Parameters:
    
    lastModifiedDate - The date the campaign was last updated in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - limits
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.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
```
CampaignResponse.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 CampaignResponse.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
```
CampaignResponse.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
```
CampaignResponse.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.
  - state
```
CampaignResponse.Builder state(CampaignState state)
```
    The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    Parameters:
    
    state - The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    
    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 campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED. 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)
  - treatmentDescription
```
CampaignResponse.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
```
CampaignResponse.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.
  - version
```
CampaignResponse.Builder version(Integer version)
```
    The campaign version number.
    
    Parameters:
    
    version - The campaign version number.
    
    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

creationDate

defaultState

defaultState

description

holdoutPercent

hook

hook

id

isPaused

lastModifiedDate

limits

limits

messageConfiguration

messageConfiguration

name

schedule

schedule

segmentId

segmentVersion

state

state

treatmentDescription

treatmentName

version