Package software.amazon.awssdk.services.pinpoint.model

Interface CampaignResponse.Builder

All Superinterfaces:

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

Enclosing class:

CampaignResponse

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

Method Summary

Modifier and Type	Method	Description
CampaignResponse.Builder	additionalTreatments(Collection<TreatmentResource> 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.
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	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.
CampaignResponse.Builder	messageConfiguration(MessageConfiguration messageConfiguration)	The message configuration settings.
CampaignResponse.Builder	name(String name)	The custom name of the campaign.
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.
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.utils.builder.CopyableBuilder

copy

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

apply, 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.

NOTE: This method appends the values to the existing list (if any). Use #setAdditionalTreatments(java.util.Collection) or #withAdditionalTreatments(java.util.Collection) if you want to override the existing values.

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.

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.

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.

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.

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.

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.

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.

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.