Interface Campaign.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Campaign.Builder,Campaign>, SdkBuilder<Campaign.Builder,Campaign>, SdkPojo
Enclosing class:
Campaign

@Mutable @NotThreadSafe public static interface Campaign.Builder extends SdkPojo, CopyableBuilder<Campaign.Builder,Campaign>
  • Method Details

    • campaignId

      Campaign.Builder campaignId(String 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

      Campaign.Builder state(String state)

      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

      Parameters:
      state - The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      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 EndOn and its assets. See CampaignState.

      Parameters:
      state - The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • campaignTemplateId

      Campaign.Builder campaignTemplateId(String 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

      Campaign.Builder language(String 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's LanguageCode, 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

      Campaign.Builder language(AssetLanguage 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's LanguageCode, 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

      Campaign.Builder 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. 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

      default Campaign.Builder partnerProfile(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. 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 the PartnerProfileBranding.Builder avoiding the need to create one manually via PartnerProfileBranding.builder().

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

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

      Campaign.Builder senderEmail(String 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

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

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

      Campaign.Builder partnerBadge(PartnerBadgeDetail 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

      default Campaign.Builder partnerBadge(Consumer<PartnerBadgeDetail.Builder> 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 the PartnerBadgeDetail.Builder avoiding the need to create one manually via PartnerBadgeDetail.builder().

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

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

      Campaign.Builder emailTarget(EmailTargetDetail 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

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

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

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

      Campaign.Builder emailTargetEngagementGroupIds(Collection<String> 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 by CreateCampaign / 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

      Campaign.Builder emailTargetEngagementGroupIds(String... 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 by CreateCampaign / 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.
    • socialConnectionsWithStrings

      Campaign.Builder socialConnectionsWithStrings(Map<String,? extends Collection<String>> 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 by UpdateCampaign. Absent until one is set.

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

      Campaign.Builder socialConnections(Map<Platform,? extends Collection<String>> 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 by UpdateCampaign. Absent until one is set.

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

      Campaign.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 Campaign.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

      Campaign.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 Campaign.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

      Campaign.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 Campaign.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:
    • startOn

      Campaign.Builder startOn(String 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

      Campaign.Builder endOn(String 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

      Campaign.Builder createdAt(Instant createdAt)

      Creation timestamp.

      Parameters:
      createdAt - Creation timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      Campaign.Builder updatedAt(Instant 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.Builder activationIssues(Collection<ActivationIssue> 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 with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (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 with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (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.Builder activationIssues(ActivationIssue... 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 with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (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 with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (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.Builder activationIssues(Consumer<ActivationIssue.Builder>... 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 with UpdateCampaign — or the profile value in PartnerProfileField — set it in Partner Central — and the assets it blocks in AffectedAssetIds. StartCampaignAssetActivationTask refuses with ValidationException (CAMPAIGN_INCOMPLETE) while a requested asset is affected.

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

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

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