Interface UpdateCampaignAssetRequest.Builder

  • 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

      UpdateCampaignAssetRequest.Builder campaignIdentifier(String 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

      UpdateCampaignAssetRequest.Builder campaignAssetIdentifier(String 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 Value omitted to clear one.

      Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; 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 with Value omitted to clear one.

      Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; 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 Value omitted to clear one.

      Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; 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 with Value omitted to clear one.

      Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; 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 Value omitted to clear one.

      Named FieldValues to match the member it edits on CampaignAsset, which is the same concept read back. It was templateFieldUpdates; the two names for one concept were the defect, not the length.

      This is a convenience method that creates an instance of the FieldValueInput.Builder avoiding the need to create one manually via FieldValueInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldValues(List<FieldValueInput>).

      Parameters:
      fieldValues - a consumer that will call methods on FieldValueInput.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 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.

      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 at ScheduledSendAt.

      A mode beside a value rather than a union, on purpose: ScheduledSendAt stays a plain Timestamp, and the precedent is EventBridge Scheduler's FlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused with ValidationException (INVALID_VALUE, naming the member) and applies nothing:

      • SCHEDULED requires ScheduledSendAt; a reschedule resends SCHEDULED with the new time;
      • ON_ACTIVATION forbids ScheduledSendAt, and drops any time already stored;
      • ScheduledSendAt without SendMode is refused.

      PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports SEND_MODE_MISSING and does not activate: no default, because an unchosen send mails the real audience. Rejected with ValidationException (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 at ScheduledSendAt.

      A mode beside a value rather than a union, on purpose: ScheduledSendAt stays a plain Timestamp, and the precedent is EventBridge Scheduler's FlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused with ValidationException ( INVALID_VALUE, naming the member) and applies nothing:

      • SCHEDULED requires ScheduledSendAt; a reschedule resends SCHEDULED with the new time;
      • ON_ACTIVATION forbids ScheduledSendAt, and drops any time already stored;
      • ScheduledSendAt without SendMode is refused.

      PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports SEND_MODE_MISSING and does not activate: no default, because an unchosen send mails the real audience. Rejected with ValidationException (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 at ScheduledSendAt.

      A mode beside a value rather than a union, on purpose: ScheduledSendAt stays a plain Timestamp, and the precedent is EventBridge Scheduler's FlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused with ValidationException (INVALID_VALUE, naming the member) and applies nothing:

      • SCHEDULED requires ScheduledSendAt; a reschedule resends SCHEDULED with the new time;
      • ON_ACTIVATION forbids ScheduledSendAt, and drops any time already stored;
      • ScheduledSendAt without SendMode is refused.

      PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports SEND_MODE_MISSING and does not activate: no default, because an unchosen send mails the real audience. Rejected with ValidationException (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 at ScheduledSendAt.

      A mode beside a value rather than a union, on purpose: ScheduledSendAt stays a plain Timestamp, and the precedent is EventBridge Scheduler's FlexibleTimeWindow { Mode, MaximumWindowInMinutes }. The pair is checked as one, and a request where they disagree is refused with ValidationException ( INVALID_VALUE, naming the member) and applies nothing:

      • SCHEDULED requires ScheduledSendAt; a reschedule resends SCHEDULED with the new time;
      • ON_ACTIVATION forbids ScheduledSendAt, and drops any time already stored;
      • ScheduledSendAt without SendMode is refused.

      PATCH: omitted leaves both unchanged. Until a mode is chosen the asset reports SEND_MODE_MISSING and does not activate: no default, because an unchosen send mails the real audience. Rejected with ValidationException (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

      UpdateCampaignAssetRequest.Builder scheduledSendAt(Instant scheduledSendAt)

      The send time, with SendMode: SCHEDULED and only then. See SendMode.

      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 with ValidationException (INVALID_VALUE) otherwise, so nothing is scheduled to send after the campaign completes.

      Was scheduleDate, a YYYY-MM-DD string. 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 concept ScheduledSendAt on the activation responses. Two spellings of one concept on one resource was the defect.

      Parameters:
      scheduledSendAt - The send time, with SendMode: SCHEDULED and only then. See SendMode.

      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 with ValidationException (INVALID_VALUE) otherwise, so nothing is scheduled to send after the campaign completes.

      Was scheduleDate, a YYYY-MM-DD string. 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 concept ScheduledSendAt on 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

      UpdateCampaignAssetRequest.Builder clientToken(String 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.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.