Interface CampaignAssetTemplate.Builder

  • Method Details

    • id

      The template-local asset template identifier.

      Parameters:
      id - The template-local asset template identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The kind of asset this blueprint instantiates as.

      Parameters:
      type - The kind of asset this blueprint instantiates as.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The kind of asset this blueprint instantiates as.

      Parameters:
      type - The kind of asset this blueprint instantiates as.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • label

      Display label; becomes the instantiated asset's name.

      Parameters:
      label - Display label; becomes the instantiated asset's name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • displayOrder

      CampaignAssetTemplate.Builder displayOrder(Integer displayOrder)

      Ordering for preview and instantiation.

      Parameters:
      displayOrder - Ordering for preview and instantiation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fields

      The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.

      Parameters:
      fields - The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fields

      The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.

      Parameters:
      fields - The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fields

      The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.

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

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

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

      CampaignAssetTemplate.Builder layoutPreviews(Collection<LayoutPreview> layoutPreviews)

      Previews of the AWS-authored layout skeleton.

      Parameters:
      layoutPreviews - Previews of the AWS-authored layout skeleton.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • layoutPreviews

      CampaignAssetTemplate.Builder layoutPreviews(LayoutPreview... layoutPreviews)

      Previews of the AWS-authored layout skeleton.

      Parameters:
      layoutPreviews - Previews of the AWS-authored layout skeleton.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • layoutPreviews

      CampaignAssetTemplate.Builder layoutPreviews(Consumer<LayoutPreview.Builder>... layoutPreviews)

      Previews of the AWS-authored layout skeleton.

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

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

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

      CampaignAssetTemplate.Builder prerequisiteAssetTemplateIds(Collection<String> prerequisiteAssetTemplateIds)

      The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.

      Parameters:
      prerequisiteAssetTemplateIds - The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • prerequisiteAssetTemplateIds

      CampaignAssetTemplate.Builder prerequisiteAssetTemplateIds(String... prerequisiteAssetTemplateIds)

      The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.

      Parameters:
      prerequisiteAssetTemplateIds - The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • socialPlatform

      CampaignAssetTemplate.Builder socialPlatform(String socialPlatform)

      SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.

      Parameters:
      socialPlatform - SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • socialPlatform

      CampaignAssetTemplate.Builder socialPlatform(Platform socialPlatform)

      SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.

      Parameters:
      socialPlatform - SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: