Interface UpdateCampaignAssetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateCampaignAssetRequest.Builder,,UpdateCampaignAssetRequest> PartnerCentralMarketingRequest.Builder,SdkBuilder<UpdateCampaignAssetRequest.Builder,,UpdateCampaignAssetRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateCampaignAssetRequest
-
Method Summary
Modifier and TypeMethodDescriptioncampaignAssetIdentifier(String campaignAssetIdentifier) The asset identifier.campaignIdentifier(String campaignIdentifier) The campaign identifier.The catalog (AWS or Sandbox).The catalog (AWS or Sandbox).clientToken(String clientToken) Idempotency token.fieldValues(Collection<FieldValueInput> fieldValues) Value-only updates to the asset's pinned template fields, keyed by FieldId.fieldValues(Consumer<FieldValueInput.Builder>... fieldValues) Value-only updates to the asset's pinned template fields, keyed by FieldId.fieldValues(FieldValueInput... fieldValues) Value-only updates to the asset's pinned template fields, keyed by FieldId.Selects a multi-layout asset's layout: one of the values inCampaignAsset.layout.options.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.scheduledSendAt(Instant scheduledSendAt) The send time, withSendMode: SCHEDULEDand only then.When a sendable asset (EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.When a sendable asset (EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.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.
-
campaignAssetIdentifier
The asset identifier.
- Parameters:
campaignAssetIdentifier- The asset identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry with
Valueomitted to clear one.Named
FieldValuesto match the member it edits onCampaignAsset, which is the same concept read back. It wastemplateFieldUpdates; the two names for one concept were the defect, not the length.- Parameters:
fieldValues- Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry withValueomitted to clear one.Named
FieldValuesto match the member it edits onCampaignAsset, which is the same concept read back. It wastemplateFieldUpdates; the two names for one concept were the defect, not the length.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry with
Valueomitted to clear one.Named
FieldValuesto match the member it edits onCampaignAsset, which is the same concept read back. It wastemplateFieldUpdates; the two names for one concept were the defect, not the length.- Parameters:
fieldValues- Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry withValueomitted to clear one.Named
FieldValuesto match the member it edits onCampaignAsset, which is the same concept read back. It wastemplateFieldUpdates; the two names for one concept were the defect, not the length.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
Value-only updates to the asset's pinned template fields, keyed by FieldId. The field schema (labels, descriptions, constraints, placeholders, image defaults) is service-owned and pinned at instantiation, so clients send only the values they are changing. Fields omitted keep their stored values; send the entry with
Valueomitted to clear one.Named
This is a convenience method that creates an instance of theFieldValuesto match the member it edits onCampaignAsset, which is the same concept read back. It wastemplateFieldUpdates; the two names for one concept were the defect, not the length.FieldValueInput.Builderavoiding the need to create one manually viaFieldValueInput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofieldValues(List<FieldValueInput>).- Parameters:
fieldValues- a consumer that will call methods onFieldValueInput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
layout
Selects a multi-layout asset's layout: one of the values in
CampaignAsset.layout.options.PATCH: omitted leaves the selection unchanged, and there is no way to clear it. A value that is not one of the asset's options — or any value on a single-layout asset — is a plain
ValidationException, and nothing in the call is applied. Every pinned field stays writable whichever layout is selected.- Parameters:
layout- Selects a multi-layout asset's layout: one of the values inCampaignAsset.layout.options.PATCH: omitted leaves the selection unchanged, and there is no way to clear it. A value that is not one of the asset's options — or any value on a single-layout asset — is a plain
ValidationException, and nothing in the call is applied. Every pinned field stays writable whichever layout is selected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sendMode
When a sendable asset (
EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.A mode beside a value rather than a union, on purpose:
ScheduledSendAtstays a plainTimestamp, and the precedent is EventBridge Scheduler'sFlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused withValidationException(INVALID_VALUE, naming the member) and applies nothing:SCHEDULEDrequiresScheduledSendAt; a reschedule resendsSCHEDULEDwith the new time;ON_ACTIVATIONforbidsScheduledSendAt, and drops any time already stored;ScheduledSendAtwithoutSendModeis refused.
PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports
SEND_MODE_MISSINGand does not activate: no default, because an unchosen send mails the real audience. Rejected withValidationException(NOT_SUPPORTED_FOR_CATEGORY) for a category that has no send (LANDING_PAGE,DOCUMENT,BANNER_AD). Like every other edit, it reaches the delivery platform at the asset's next activation, and a live email or social post refuses it (ASSET_ALREADY_ACTIVE): deactivate first.- Parameters:
sendMode- When a sendable asset (EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.A mode beside a value rather than a union, on purpose:
ScheduledSendAtstays a plainTimestamp, and the precedent is EventBridge Scheduler'sFlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused withValidationException(INVALID_VALUE, naming the member) and applies nothing:SCHEDULEDrequiresScheduledSendAt; a reschedule resendsSCHEDULEDwith the new time;ON_ACTIVATIONforbidsScheduledSendAt, and drops any time already stored;ScheduledSendAtwithoutSendModeis refused.
PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports
SEND_MODE_MISSINGand does not activate: no default, because an unchosen send mails the real audience. Rejected withValidationException(NOT_SUPPORTED_FOR_CATEGORY) for a category that has no send (LANDING_PAGE,DOCUMENT,BANNER_AD). Like every other edit, it reaches the delivery platform at the asset's next activation, and a live email or social post refuses it (ASSET_ALREADY_ACTIVE): deactivate first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sendMode
When a sendable asset (
EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.A mode beside a value rather than a union, on purpose:
ScheduledSendAtstays a plainTimestamp, and the precedent is EventBridge Scheduler'sFlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused withValidationException(INVALID_VALUE, naming the member) and applies nothing:SCHEDULEDrequiresScheduledSendAt; a reschedule resendsSCHEDULEDwith the new time;ON_ACTIVATIONforbidsScheduledSendAt, and drops any time already stored;ScheduledSendAtwithoutSendModeis refused.
PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports
SEND_MODE_MISSINGand does not activate: no default, because an unchosen send mails the real audience. Rejected withValidationException(NOT_SUPPORTED_FOR_CATEGORY) for a category that has no send (LANDING_PAGE,DOCUMENT,BANNER_AD). Like every other edit, it reaches the delivery platform at the asset's next activation, and a live email or social post refuses it (ASSET_ALREADY_ACTIVE): deactivate first.- Parameters:
sendMode- When a sendable asset (EMAIL,SOCIAL_POST) sends: on activation, or atScheduledSendAt.A mode beside a value rather than a union, on purpose:
ScheduledSendAtstays a plainTimestamp, and the precedent is EventBridge Scheduler'sFlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused withValidationException(INVALID_VALUE, naming the member) and applies nothing:SCHEDULEDrequiresScheduledSendAt; a reschedule resendsSCHEDULEDwith the new time;ON_ACTIVATIONforbidsScheduledSendAt, and drops any time already stored;ScheduledSendAtwithoutSendModeis refused.
PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports
SEND_MODE_MISSINGand does not activate: no default, because an unchosen send mails the real audience. Rejected withValidationException(NOT_SUPPORTED_FOR_CATEGORY) for a category that has no send (LANDING_PAGE,DOCUMENT,BANNER_AD). Like every other edit, it reaches the delivery platform at the asset's next activation, and a live email or social post refuses it (ASSET_ALREADY_ACTIVE): deactivate first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduledSendAt
The send time, with
SendMode: SCHEDULEDand only then. SeeSendMode.Must be at least an hour out (
SEND_WINDOW_TOO_SOON), unless it is the time already stored: resending the stored mode and time changes nothing and is accepted, so a form that always resubmits does not trip the window.Must also fall on or before the campaign's
EndOn(by the end of that UTC day): refused withValidationException(INVALID_VALUE) otherwise, so nothing is scheduled to send after the campaign completes.Was
scheduleDate, aYYYY-MM-DDstring. Retyped because a date alone cannot express a send time, which is the whole point of a schedule — and because the resource already spelled the same conceptScheduledSendAton the activation responses. Two spellings of one concept on one resource was the defect.- Parameters:
scheduledSendAt- The send time, withSendMode: SCHEDULEDand only then. SeeSendMode.Must be at least an hour out (
SEND_WINDOW_TOO_SOON), unless it is the time already stored: resending the stored mode and time changes nothing and is accepted, so a form that always resubmits does not trip the window.Must also fall on or before the campaign's
EndOn(by the end of that UTC day): refused withValidationException(INVALID_VALUE) otherwise, so nothing is scheduled to send after the campaign completes.Was
scheduleDate, aYYYY-MM-DDstring. Retyped because a date alone cannot express a send time, which is the whole point of a schedule — and because the resource already spelled the same conceptScheduledSendAton the activation responses. Two spellings of one concept on one resource was the defect.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
Idempotency token. Retry-safety only — this is not a concurrency token, and sequential edits to one field are last-writer-wins.
- Parameters:
clientToken- Idempotency token. Retry-safety only — this is not a concurrency token, and sequential edits to one field are last-writer-wins.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateCampaignAssetRequest.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
UpdateCampaignAssetRequest.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.
-