Interface CampaignAssetTemplate.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<CampaignAssetTemplate.Builder,,CampaignAssetTemplate> SdkBuilder<CampaignAssetTemplate.Builder,,CampaignAssetTemplate> SdkPojo
- Enclosing class:
CampaignAssetTemplate
-
Method Summary
Modifier and TypeMethodDescriptiondisplayOrder(Integer displayOrder) Ordering for preview and instantiation.fields(Collection<CampaignAssetTemplateField> fields) The editable-field schema, copied and pinned onto each campaign asset at create.fields(Consumer<CampaignAssetTemplateField.Builder>... fields) The editable-field schema, copied and pinned onto each campaign asset at create.fields(CampaignAssetTemplateField... fields) The editable-field schema, copied and pinned onto each campaign asset at create.The template-local asset template identifier.Display label; becomes the instantiated asset's name.layoutPreviews(Collection<LayoutPreview> layoutPreviews) Previews of the AWS-authored layout skeleton.layoutPreviews(Consumer<LayoutPreview.Builder>... layoutPreviews) Previews of the AWS-authored layout skeleton.layoutPreviews(LayoutPreview... layoutPreviews) Previews of the AWS-authored layout skeleton.prerequisiteAssetTemplateIds(String... prerequisiteAssetTemplateIds) The asset templates this one embeds output from, such as an email's landing page.prerequisiteAssetTemplateIds(Collection<String> prerequisiteAssetTemplateIds) The asset templates this one embeds output from, such as an email's landing page.socialPlatform(String socialPlatform) SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports asSocialPlatform.socialPlatform(Platform socialPlatform) SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports asSocialPlatform.The kind of asset this blueprint instantiates as.The kind of asset this blueprint instantiates as.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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
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 theCampaignAssetTemplateField.Builderavoiding the need to create one manually viaCampaignAssetTemplateField.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofields(List<CampaignAssetTemplateField>).- Parameters:
fields- a consumer that will call methods onCampaignAssetTemplateField.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
Previews of the AWS-authored layout skeleton.
This is a convenience method that creates an instance of theLayoutPreview.Builderavoiding the need to create one manually viaLayoutPreview.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolayoutPreviews(List<LayoutPreview>).- Parameters:
layoutPreviews- a consumer that will call methods onLayoutPreview.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
BatchCreateCampaignAssetrequest or already an asset on the campaign, else the create is refusedPREREQUISITE_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 anAssetLinkfield 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 sameBatchCreateCampaignAssetrequest or already an asset on the campaign, else the create is refusedPREREQUISITE_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 anAssetLinkfield and needs nothing at create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prerequisiteAssetTemplateIds
The asset templates this one embeds output from, such as an email's landing page. Each must be in the same
BatchCreateCampaignAssetrequest or already an asset on the campaign, else the create is refusedPREREQUISITE_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 anAssetLinkfield 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 sameBatchCreateCampaignAssetrequest or already an asset on the campaign, else the create is refusedPREREQUISITE_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 anAssetLinkfield and needs nothing at create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 asSocialPlatform. 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
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.socialPlatform- SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports asSocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.PlatformPlatform