Interface UpdateCampaignRequest.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

      UpdateCampaignRequest.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.
    • 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

      UpdateCampaignRequest.Builder senderEmail(String 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, and StartCampaignAssetActivationTask re-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 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, and StartCampaignAssetActivationTask re-checks it before an email activates.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privacyPolicyUrl

      UpdateCampaignRequest.Builder privacyPolicyUrl(String 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

      UpdateCampaignRequest.Builder partnerAddress(String 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

      UpdateCampaignRequest.Builder partnerBadge(FileRef 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • partnerBadge

      default UpdateCampaignRequest.Builder partnerBadge(Consumer<FileRef.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to partnerBadge(FileRef).

      Parameters:
      partnerBadge - a consumer that will call methods on FileRef.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • emailTarget

      UpdateCampaignRequest.Builder emailTarget(FileRef 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

      default UpdateCampaignRequest.Builder emailTarget(Consumer<FileRef.Builder> 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.Builder avoiding the need to create one manually via FileRef.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailTarget(FileRef).

      Parameters:
      emailTarget - a consumer that will call methods on FileRef.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 (see CreateCampaign). 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 (see CreateCampaign). Replaces the stored list; never clears it.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • socialConnectionsWithStrings

      UpdateCampaignRequest.Builder socialConnectionsWithStrings(Map<String,? 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.
    • 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

      UpdateCampaignRequest.Builder estimatedBudget(MonetaryValue 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 the MonetaryValue.Builder avoiding the need to create one manually via MonetaryValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to estimatedBudget(MonetaryValue).

      Parameters:
      estimatedBudget - a consumer that will call methods on MonetaryValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • totalBudget

      UpdateCampaignRequest.Builder totalBudget(MonetaryValue 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

      default UpdateCampaignRequest.Builder totalBudget(Consumer<MonetaryValue.Builder> totalBudget)

      The campaign's total budget.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to totalBudget(MonetaryValue).

      Parameters:
      totalBudget - a consumer that will call methods on MonetaryValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • targetAudience

      UpdateCampaignRequest.Builder targetAudience(TargetAudience 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 the TargetAudience.Builder avoiding the need to create one manually via TargetAudience.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetAudience(TargetAudience).

      Parameters:
      targetAudience - a consumer that will call methods on TargetAudience.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • clientToken

      UpdateCampaignRequest.Builder clientToken(String 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 after EndOn ( 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 EndOn has passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused with ValidationException (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 EndOn has passed the campaign is completed and this update is refused ( CAMPAIGN_COMPLETED). Refused with ValidationException ( 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.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.