Interface Campaign.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<Campaign.Builder,,Campaign> SdkBuilder<Campaign.Builder,,Campaign> SdkPojo
- Enclosing class:
Campaign
-
Method Summary
Modifier and TypeMethodDescriptionactivationIssues(Collection<ActivationIssue> activationIssues) Campaign settings that must be set before the assets listed in each issue can be activated.activationIssues(Consumer<ActivationIssue.Builder>... activationIssues) Campaign settings that must be set before the assets listed in each issue can be activated.activationIssues(ActivationIssue... activationIssues) Campaign settings that must be set before the assets listed in each issue can be activated.The campaign ARN.campaignId(String campaignId) The campaign identifier.campaignTemplateId(String campaignTemplateId) The campaign template this campaign draws its assets from.Creation timestamp.default Campaign.BuilderemailTarget(Consumer<EmailTargetDetail.Builder> emailTarget) The attached recipient list — metadata only.emailTarget(EmailTargetDetail emailTarget) The attached recipient list — metadata only.emailTargetEngagementGroupIds(String... emailTargetEngagementGroupIds) The engagement groups set byCreateCampaign/UpdateCampaign.emailTargetEngagementGroupIds(Collection<String> emailTargetEngagementGroupIds) The engagement groups set byCreateCampaign/UpdateCampaign.The last day of the campaign's run window.default Campaign.BuilderestimatedBudget(Consumer<MonetaryValue.Builder> estimatedBudget) What the partner expects the campaign to cost.estimatedBudget(MonetaryValue estimatedBudget) What the partner expects the campaign to cost.The language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create.language(AssetLanguage language) The language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create.The display name.partnerAddress(String partnerAddress) The partner's postal address.default Campaign.BuilderpartnerBadge(Consumer<PartnerBadgeDetail.Builder> partnerBadge) The partner's badge.partnerBadge(PartnerBadgeDetail partnerBadge) The partner's badge.default Campaign.BuilderpartnerProfile(Consumer<PartnerProfileBranding.Builder> partnerProfile) The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign.partnerProfile(PartnerProfileBranding partnerProfile) The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign.privacyPolicyUrl(String privacyPolicyUrl) The URL of the partner's privacy policy.senderEmail(String senderEmail) The address the campaign's emails are sent from.socialConnections(Map<Platform, ? extends Collection<String>> socialConnections) The account the campaign's social posts publish from, per platform, as set byUpdateCampaign.socialConnectionsWithStrings(Map<String, ? extends Collection<String>> socialConnections) The account the campaign's social posts publish from, per platform, as set byUpdateCampaign.The first day of the campaign's run window.The campaign's state, derived on every read fromEndOnand its assets.state(CampaignState state) The campaign's state, derived on every read fromEndOnand its assets.default Campaign.BuildertargetAudience(Consumer<TargetAudience.Builder> targetAudience) Target audience configuration.targetAudience(TargetAudience targetAudience) Target audience configuration.default Campaign.BuildertotalBudget(Consumer<MonetaryValue.Builder> totalBudget) The campaign's total budget.totalBudget(MonetaryValue totalBudget) The campaign's total budget.Last update timestamp.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
campaignId
The campaign identifier.
- Parameters:
campaignId- The campaign identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The campaign ARN.
- Parameters:
arn- The campaign ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The display name.
- Parameters:
name- The display name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.- Parameters:
state- The campaign's state, derived on every read fromEndOnand its assets. SeeCampaignState.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.- Parameters:
state- The campaign's state, derived on every read fromEndOnand its assets. SeeCampaignState.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
campaignTemplateId
The campaign template this campaign draws its assets from. Set at create, immutable.
- Parameters:
campaignTemplateId- The campaign template this campaign draws its assets from. Set at create, immutable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
language
The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template.- Parameters:
language- The language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create. To work in another language, create the campaign from that language's template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
language
The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template.- Parameters:
language- The language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create. To work in another language, create the campaign from that language's template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
partnerProfile
The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.
- Parameters:
partnerProfile- The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerProfile
The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.
This is a convenience method that creates an instance of thePartnerProfileBranding.Builderavoiding the need to create one manually viaPartnerProfileBranding.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topartnerProfile(PartnerProfileBranding).- Parameters:
partnerProfile- a consumer that will call methods onPartnerProfileBranding.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
senderEmail
The address the campaign's emails are sent from. Absent until one is set.
- Parameters:
senderEmail- The address the campaign's emails are sent from. Absent until one is set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privacyPolicyUrl
The URL of the partner's privacy policy. Absent until one is set.
- Parameters:
privacyPolicyUrl- The URL of the partner's privacy policy. Absent until one is set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerAddress
The partner's postal address. Absent until one is set.
- Parameters:
partnerAddress- The partner's postal address. Absent until one is set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerBadge
The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.
- Parameters:
partnerBadge- The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerBadge
The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.
This is a convenience method that creates an instance of thePartnerBadgeDetail.Builderavoiding the need to create one manually viaPartnerBadgeDetail.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topartnerBadge(PartnerBadgeDetail).- Parameters:
partnerBadge- a consumer that will call methods onPartnerBadgeDetail.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emailTarget
The attached recipient list — metadata only. There is no read path for the addresses.
- Parameters:
emailTarget- The attached recipient list — metadata only. There is no read path for the addresses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTarget
The attached recipient list — metadata only. There is no read path for the addresses.
This is a convenience method that creates an instance of theEmailTargetDetail.Builderavoiding the need to create one manually viaEmailTargetDetail.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toemailTarget(EmailTargetDetail).- Parameters:
emailTarget- a consumer that will call methods onEmailTargetDetail.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emailTargetEngagementGroupIds
The engagement groups set by
CreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.- Parameters:
emailTargetEngagementGroupIds- The engagement groups set byCreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTargetEngagementGroupIds
The engagement groups set by
CreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.- Parameters:
emailTargetEngagementGroupIds- The engagement groups set byCreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
socialConnections
The account the campaign's social posts publish from, per platform, as set by
UpdateCampaign. Absent until one is set.Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails `SOCIAL_CONNECTION_NOT_CHOSEN` when you hold several. A choice that no longer names a connection on its platform fails `SOCIAL_CONNECTION_MISSING`. Join with `ListSocialConnections` for each connection's status.
- Parameters:
socialConnections- The account the campaign's social posts publish from, per platform, as set byUpdateCampaign. Absent until one is set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
estimatedBudget
What the partner expects the campaign to cost.
- Parameters:
estimatedBudget- What the partner expects the campaign to cost.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
estimatedBudget
What the partner expects the campaign to cost.
This is a convenience method that creates an instance of theMonetaryValue.Builderavoiding the need to create one manually viaMonetaryValue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toestimatedBudget(MonetaryValue).- Parameters:
estimatedBudget- a consumer that will call methods onMonetaryValue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
totalBudget
The campaign's total budget.
- Parameters:
totalBudget- The campaign's total budget.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
totalBudget
The campaign's total budget.
This is a convenience method that creates an instance of theMonetaryValue.Builderavoiding the need to create one manually viaMonetaryValue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tototalBudget(MonetaryValue).- Parameters:
totalBudget- a consumer that will call methods onMonetaryValue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetAudience
Target audience configuration.
- Parameters:
targetAudience- Target audience configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetAudience
Target audience configuration.
This is a convenience method that creates an instance of theTargetAudience.Builderavoiding the need to create one manually viaTargetAudience.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totargetAudience(TargetAudience).- Parameters:
targetAudience- a consumer that will call methods onTargetAudience.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startOn
The first day of the campaign's run window.
- Parameters:
startOn- The first day of the campaign's run window.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endOn
The last day of the campaign's run window.
- Parameters:
endOn- The last day of the campaign's run window.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
Creation timestamp.
- Parameters:
createdAt- Creation timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
Last update timestamp.
- Parameters:
updatedAt- Last update timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationIssues
Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.
Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.- Parameters:
activationIssues- Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationIssues
Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.
Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.- Parameters:
activationIssues- Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationIssues
Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.
Each issue names the setting in
This is a convenience method that creates an instance of theCampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.ActivationIssue.Builderavoiding the need to create one manually viaActivationIssue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toactivationIssues(List<ActivationIssue>).- Parameters:
activationIssues- a consumer that will call methods onActivationIssue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
socialConnectionsWithStrings
The account the campaign's social posts publish from, per platform, as set by
UpdateCampaign. Absent until one is set.Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails `SOCIAL_CONNECTION_NOT_CHOSEN` when you hold several. A choice that no longer names a connection on its platform fails `SOCIAL_CONNECTION_MISSING`. Join with `ListSocialConnections` for each connection's status.
socialConnections- The account the campaign's social posts publish from, per platform, as set byUpdateCampaign. Absent until one is set.