Interface CampaignTemplate.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<CampaignTemplate.Builder,,CampaignTemplate> SdkBuilder<CampaignTemplate.Builder,,CampaignTemplate> SdkPojo
- Enclosing class:
CampaignTemplate
-
Method Summary
Modifier and TypeMethodDescriptionassetTemplates(Collection<CampaignAssetTemplate> assetTemplates) The ordered asset blueprints.assetTemplates(Consumer<CampaignAssetTemplate.Builder>... assetTemplates) The ordered asset blueprints.assetTemplates(CampaignAssetTemplate... assetTemplates) The ordered asset blueprints.awsServices(String... awsServices) AWS services the template promotes.awsServices(Collection<String> awsServices) AWS services the template promotes.collection(String collection) The browsing context the template is listed in.collection(CampaignTemplateCollection collection) The browsing context the template is listed in.Creation timestamp.customerSegments(Collection<CustomerSegment> customerSegments) The customer segments the template is written for.customerSegments(CustomerSegment... customerSegments) The customer segments the template is written for.customerSegmentsWithStrings(String... customerSegments) The customer segments the template is written for.customerSegmentsWithStrings(Collection<String> customerSegments) The customer segments the template is written for.description(String description) A short overview of the campaign, as plain text in the template's language: no HTML and no character entities.effectiveDateBegin(Instant effectiveDateBegin) The instant the template becomes available to partners.The campaign template identifier.Target industry for filtering or categorization.Target industry for filtering or categorization.languageCode(String languageCode) Language the template is authored in, which a campaign created from it takes.languageCode(AssetLanguage languageCode) Language the template is authored in, which a campaign created from it takes.The display name.referenceMaterials(Collection<ReferenceMaterial> referenceMaterials) The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels.referenceMaterials(Consumer<ReferenceMaterial.Builder>... referenceMaterials) The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels.referenceMaterials(ReferenceMaterial... referenceMaterials) The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels.setupDuration(String setupDuration) Estimated setup time.themes(Collection<Theme> themes) The template's marketing themes.The template's marketing themes.themesWithStrings(String... themes) The template's marketing themes.themesWithStrings(Collection<String> themes) The template's marketing themes.thumbnailUrl(String thumbnailUrl) Thumbnail URL.Last update timestamp.Campaign use case for filtering or categorization.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 campaign template identifier.
- Parameters:
id- The campaign template 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.
-
industry
Target industry for filtering or categorization.
- Parameters:
industry- Target industry for filtering or categorization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
industry
Target industry for filtering or categorization.
- Parameters:
industry- Target industry for filtering or categorization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
useCase
Campaign use case for filtering or categorization.
- Parameters:
useCase- Campaign use case for filtering or categorization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A short overview of the campaign, as plain text in the template's language: no HTML and no character entities. Absent when the template has none; never an empty string.
- Parameters:
description- A short overview of the campaign, as plain text in the template's language: no HTML and no character entities. Absent when the template has none; never an empty string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageCode
Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.
- Parameters:
languageCode- Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.
- Parameters:
languageCode- Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
collection
The browsing context the template is listed in. Every template has exactly one.
- Parameters:
collection- The browsing context the template is listed in. Every template has exactly one.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
collection
The browsing context the template is listed in. Every template has exactly one.
- Parameters:
collection- The browsing context the template is listed in. Every template has exactly one.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsServices
AWS services the template promotes.
- Parameters:
awsServices- AWS services the template promotes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsServices
AWS services the template promotes.
- Parameters:
awsServices- AWS services the template promotes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerSegmentsWithStrings
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.- Parameters:
customerSegments- The customer segments the template is written for. Absent when the template names none, in which case it matches everyCustomerSegmentssearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerSegmentsWithStrings
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.- Parameters:
customerSegments- The customer segments the template is written for. Absent when the template names none, in which case it matches everyCustomerSegmentssearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerSegments
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.- Parameters:
customerSegments- The customer segments the template is written for. Absent when the template names none, in which case it matches everyCustomerSegmentssearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerSegments
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.- Parameters:
customerSegments- The customer segments the template is written for. Absent when the template names none, in which case it matches everyCustomerSegmentssearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
themesWithStrings
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.- Parameters:
themes- The template's marketing themes. Absent when the template names none, in which case it matches everyThemessearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
themesWithStrings
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.- Parameters:
themes- The template's marketing themes. Absent when the template names none, in which case it matches everyThemessearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
themes
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.- Parameters:
themes- The template's marketing themes. Absent when the template names none, in which case it matches everyThemessearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
themes
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.- Parameters:
themes- The template's marketing themes. Absent when the template names none, in which case it matches everyThemessearch filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setupDuration
Estimated setup time.
- Parameters:
setupDuration- Estimated setup time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
thumbnailUrl
Thumbnail URL.
- Parameters:
thumbnailUrl- Thumbnail URL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
effectiveDateBegin
The instant the template becomes available to partners. Until then the template does not exist to a partner: SearchCampaignTemplates omits it and GetCampaignTemplate returns ResourceNotFoundException.
- Parameters:
effectiveDateBegin- The instant the template becomes available to partners. Until then the template does not exist to a partner: SearchCampaignTemplates omits it and GetCampaignTemplate returns ResourceNotFoundException.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assetTemplates
The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
- Parameters:
assetTemplates- The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assetTemplates
The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
- Parameters:
assetTemplates- The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assetTemplates
The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
This is a convenience method that creates an instance of theCampaignAssetTemplate.Builderavoiding the need to create one manually viaCampaignAssetTemplate.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toassetTemplates(List<CampaignAssetTemplate>).- Parameters:
assetTemplates- a consumer that will call methods onCampaignAssetTemplate.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
referenceMaterials
The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from
AssetTemplatesbecause none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited aBatchCreateCampaignAssetthat could only fail.Absent when the template has none.
- Parameters:
referenceMaterials- The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart fromAssetTemplatesbecause none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited aBatchCreateCampaignAssetthat could only fail.Absent when the template has none.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
referenceMaterials
The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from
AssetTemplatesbecause none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited aBatchCreateCampaignAssetthat could only fail.Absent when the template has none.
- Parameters:
referenceMaterials- The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart fromAssetTemplatesbecause none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited aBatchCreateCampaignAssetthat could only fail.Absent when the template has none.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
referenceMaterials
CampaignTemplate.Builder referenceMaterials(Consumer<ReferenceMaterial.Builder>... referenceMaterials) The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from
AssetTemplatesbecause none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited aBatchCreateCampaignAssetthat could only fail.Absent when the template has none.
This is a convenience method that creates an instance of theReferenceMaterial.Builderavoiding the need to create one manually viaReferenceMaterial.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toreferenceMaterials(List<ReferenceMaterial>).- Parameters:
referenceMaterials- a consumer that will call methods onReferenceMaterial.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdAt
Creation timestamp.
- Parameters:
createdAt- Creation timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
Last update timestamp.
- Parameters:
updatedAt- Last update timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-