Interface UpdateCampaignRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateCampaignRequest.Builder,,UpdateCampaignRequest> PartnerCentralMarketingRequest.Builder,SdkBuilder<UpdateCampaignRequest.Builder,,UpdateCampaignRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateCampaignRequest
-
Method Summary
Modifier and TypeMethodDescriptioncampaignIdentifier(String campaignIdentifier) The campaign identifier.The catalog (AWS or Sandbox).The catalog (AWS or Sandbox).clientToken(String clientToken) Idempotency token.default UpdateCampaignRequest.BuilderemailTarget(Consumer<FileRef.Builder> emailTarget) Replaces the campaign's attached recipient list.emailTarget(FileRef emailTarget) Replaces the campaign's attached recipient list.emailTargetEngagementGroupIds(String... emailTargetEngagementGroupIds) Engagement groups whose contacts the campaign's emails will also go to (seeCreateCampaign).emailTargetEngagementGroupIds(Collection<String> emailTargetEngagementGroupIds) Engagement groups whose contacts the campaign's emails will also go to (seeCreateCampaign).The last day of the campaign's run window, inclusive and in UTC.default UpdateCampaignRequest.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 display name.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.partnerAddress(String partnerAddress) Sets or replaces the partner's postal address.default UpdateCampaignRequest.BuilderpartnerBadge(Consumer<FileRef.Builder> partnerBadge) Sets or replaces the partner's badge, checked exactly as onCreateCampaign.partnerBadge(FileRef partnerBadge) Sets or replaces the partner's badge, checked exactly as onCreateCampaign.privacyPolicyUrl(String privacyPolicyUrl) Sets or replaces the URL of the partner's privacy policy.senderEmail(String senderEmail) Sets or replaces the address the campaign's emails are sent from.socialConnections(Map<Platform, ? extends Collection<String>> socialConnections) Sets the account the campaign's social posts publish from, per platform.socialConnectionsWithStrings(Map<String, ? extends Collection<String>> socialConnections) Sets the account the campaign's social posts publish from, per platform.The first day of the campaign's run window.default UpdateCampaignRequest.BuildertargetAudience(Consumer<TargetAudience.Builder> targetAudience) Target audience configuration.targetAudience(TargetAudience targetAudience) Target audience configuration.default UpdateCampaignRequest.BuildertotalBudget(Consumer<MonetaryValue.Builder> totalBudget) The campaign's total budget.totalBudget(MonetaryValue totalBudget) The campaign's total budget.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.partnercentralmarketing.model.PartnerCentralMarketingRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
catalog
The catalog (AWS or Sandbox).
- Parameters:
catalog- The catalog (AWS or Sandbox).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
catalog
The catalog (AWS or Sandbox).
- Parameters:
catalog- The catalog (AWS or Sandbox).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
campaignIdentifier
The campaign identifier.
- Parameters:
campaignIdentifier- The campaign identifier.- 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.
-
senderEmail
Sets or replaces the address the campaign's emails are sent from. Checked by the same three rules as on
CreateCampaign, with the same codes, but only when it differs, ignoring case, from the stored sender: re-sending the stored one is not checked, andStartCampaignAssetActivationTaskre-checks it before an email activates.Replaces, never clears: like every member of this operation, an omitted value leaves the sender as it was, and there is no way to remove one once set.
- Parameters:
senderEmail- Sets or replaces the address the campaign's emails are sent from. Checked by the same three rules as onCreateCampaign, with the same codes, but only when it differs, ignoring case, from the stored sender: re-sending the stored one is not checked, andStartCampaignAssetActivationTaskre-checks it before an email activates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privacyPolicyUrl
Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.
- Parameters:
privacyPolicyUrl- Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerAddress
Sets or replaces the partner's postal address. Replaces, never clears.
- Parameters:
partnerAddress- Sets or replaces the partner's postal address. Replaces, never clears.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerBadge
Sets or replaces the partner's badge, checked exactly as on
CreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.- Parameters:
partnerBadge- Sets or replaces the partner's badge, checked exactly as onCreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partnerBadge
Sets or replaces the partner's badge, checked exactly as on
This is a convenience method that creates an instance of theCreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.FileRef.Builderavoiding the need to create one manually viaFileRef.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topartnerBadge(FileRef).- Parameters:
partnerBadge- a consumer that will call methods onFileRef.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emailTarget
Replaces the campaign's attached recipient list.
The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the *last* `UpdateCampaign` that named one. Editing the source object in your own bucket without calling this operation again has no effect.
Replaces, never detaches: a partner can swap the list but cannot remove it.
- Parameters:
emailTarget- Replaces the campaign's attached recipient list.The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the *last* `UpdateCampaign` that named one. Editing the source object in your own bucket without calling this operation again has no effect.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTarget
Replaces the campaign's attached recipient list.
The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the *last* `UpdateCampaign` that named one. Editing the source object in your own bucket without calling this operation again has no effect.
Replaces, never detaches: a partner can swap the list but cannot remove it. This is a convenience method that creates an instance of the
FileRef.Builderavoiding the need to create one manually viaFileRef.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toemailTarget(FileRef).- Parameters:
emailTarget- a consumer that will call methods onFileRef.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emailTargetEngagementGroupIds
UpdateCampaignRequest.Builder emailTargetEngagementGroupIds(Collection<String> emailTargetEngagementGroupIds) Engagement groups whose contacts the campaign's emails will also go to (see
CreateCampaign). Replaces the stored list; never clears it.As on `CreateCampaign`: each group once (`INVALID_VALUE` otherwise), not checked against your groups when saved, and resolved at Start where the stage can (`ENGAGEMENT_GROUPS_UNAVAILABLE` where it can't).
- Parameters:
emailTargetEngagementGroupIds- Engagement groups whose contacts the campaign's emails will also go to (seeCreateCampaign). Replaces the stored list; never clears it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTargetEngagementGroupIds
UpdateCampaignRequest.Builder emailTargetEngagementGroupIds(String... emailTargetEngagementGroupIds) Engagement groups whose contacts the campaign's emails will also go to (see
CreateCampaign). Replaces the stored list; never clears it.As on `CreateCampaign`: each group once (`INVALID_VALUE` otherwise), not checked against your groups when saved, and resolved at Start where the stage can (`ENGAGEMENT_GROUPS_UNAVAILABLE` where it can't).
- Parameters:
emailTargetEngagementGroupIds- Engagement groups whose contacts the campaign's emails will also go to (seeCreateCampaign). Replaces the stored list; never clears it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
socialConnections
UpdateCampaignRequest.Builder socialConnections(Map<Platform, ? extends Collection<String>> socialConnections) Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
Not checked against your connections here: a connection can be deleted at any time, so the activation checks the choice. See `Campaign$SocialConnections`.
- Parameters:
socialConnections- Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.- 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
default UpdateCampaignRequest.Builder estimatedBudget(Consumer<MonetaryValue.Builder> 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
default UpdateCampaignRequest.Builder targetAudience(Consumer<TargetAudience.Builder> 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:
-
clientToken
Idempotency token. Accepted and not stored: this is a change-only partial update with last-writer-wins, so re-applying the same call produces the same result and the same response. There is nothing a replay cache would protect.
- Parameters:
clientToken- Idempotency token. Accepted and not stored: this is a change-only partial update with last-writer-wins, so re-applying the same call produces the same result and the same response. There is nothing a replay cache would protect.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startOn
The first day of the campaign's run window. Not after
EndOn(ValidationException,INVALID_VALUE).- Parameters:
startOn- The first day of the campaign's run window. Not afterEndOn(ValidationException,INVALID_VALUE).- 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, inclusive and in UTC.
Editable only while the campaign is open, like everything else here: once the stored
EndOnhas passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused withValidationException(INVALID_VALUE) when it is in the past, or earlier than the day of a scheduled send on one of the campaign's assets: move or cancel that send first. Setting it to today ends the campaign at the next UTC midnight.- Parameters:
endOn- The last day of the campaign's run window, inclusive and in UTC.Editable only while the campaign is open, like everything else here: once the stored
EndOnhas passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused withValidationException(INVALID_VALUE) when it is in the past, or earlier than the day of a scheduled send on one of the campaign's assets: move or cancel that send first. Setting it to today ends the campaign at the next UTC midnight.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateCampaignRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-
socialConnectionsWithStrings
Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
Not checked against your connections here: a connection can be deleted at any time, so the activation checks the choice. See `Campaign$SocialConnections`.
socialConnections- Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.