Class CampaignTemplate
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CampaignTemplate.Builder,CampaignTemplate>
A platform-managed campaign template — an AWS-authored kit of asset blueprints a partner creates a campaign from.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<CampaignAssetTemplate> The ordered asset blueprints.AWS services the template promotes.static CampaignTemplate.Builderbuilder()The browsing context the template is listed in.final StringThe browsing context the template is listed in.final InstantCreation timestamp.final List<CustomerSegment> The customer segments the template is written for.The customer segments the template is written for.final StringA short overview of the campaign, as plain text in the template's language: no HTML and no character entities.final InstantThe instant the template becomes available to partners.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the AssetTemplates property.final booleanFor responses, this returns true if the service returned a value for the AwsServices property.final booleanFor responses, this returns true if the service returned a value for the CustomerSegments property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the ReferenceMaterials property.final booleanFor responses, this returns true if the service returned a value for the Themes property.final Stringid()The campaign template identifier.final Industryindustry()Target industry for filtering or categorization.final StringTarget industry for filtering or categorization.final AssetLanguageLanguage the template is authored in, which a campaign created from it takes.final StringLanguage the template is authored in, which a campaign created from it takes.final Stringname()The display name.final List<ReferenceMaterial> The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels.static Class<? extends CampaignTemplate.Builder> final StringEstimated setup time.themes()The template's marketing themes.The template's marketing themes.final StringThumbnail URL.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InstantLast update timestamp.final StringuseCase()Campaign use case for filtering or categorization.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The campaign template identifier.
- Returns:
- The campaign template identifier.
-
name
-
industry
Target industry for filtering or categorization.
If the service returns an enum value that is not available in the current SDK version,
industrywill returnIndustry.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromindustryAsString().- Returns:
- Target industry for filtering or categorization.
- See Also:
-
industryAsString
Target industry for filtering or categorization.
If the service returns an enum value that is not available in the current SDK version,
industrywill returnIndustry.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromindustryAsString().- Returns:
- Target industry for filtering or categorization.
- See Also:
-
useCase
Campaign use case for filtering or categorization.
- Returns:
- Campaign use case for filtering or categorization.
-
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:
- 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
languageCodewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- 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.
- See Also:
-
languageCodeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
languageCodewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- 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.
- See Also:
-
collection
The browsing context the template is listed in. Every template has exactly one.
If the service returns an enum value that is not available in the current SDK version,
collectionwill returnCampaignTemplateCollection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcollectionAsString().- Returns:
- The browsing context the template is listed in. Every template has exactly one.
- See Also:
-
collectionAsString
The browsing context the template is listed in. Every template has exactly one.
If the service returns an enum value that is not available in the current SDK version,
collectionwill returnCampaignTemplateCollection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcollectionAsString().- Returns:
- The browsing context the template is listed in. Every template has exactly one.
- See Also:
-
hasAwsServices
public final boolean hasAwsServices()For responses, this returns true if the service returned a value for the AwsServices property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
awsServices
AWS services the template promotes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAwsServices()method.- Returns:
- AWS services the template promotes.
-
customerSegments
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCustomerSegments()method.- Returns:
- The customer segments the template is written for. Absent when the template names none, in which case it
matches every
CustomerSegmentssearch filter.
-
hasCustomerSegments
public final boolean hasCustomerSegments()For responses, this returns true if the service returned a value for the CustomerSegments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
customerSegmentsAsStrings
The customer segments the template is written for. Absent when the template names none, in which case it matches every
CustomerSegmentssearch filter.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCustomerSegments()method.- Returns:
- The customer segments the template is written for. Absent when the template names none, in which case it
matches every
CustomerSegmentssearch filter.
-
themes
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasThemes()method.- Returns:
- The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.
-
hasThemes
public final boolean hasThemes()For responses, this returns true if the service returned a value for the Themes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
themesAsStrings
The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasThemes()method.- Returns:
- The template's marketing themes. Absent when the template names none, in which case it matches every
Themessearch filter.
-
setupDuration
-
thumbnailUrl
-
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:
- 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.
-
hasAssetTemplates
public final boolean hasAssetTemplates()For responses, this returns true if the service returned a value for the AssetTemplates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
assetTemplates
The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAssetTemplates()method.- Returns:
- The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
-
hasReferenceMaterials
public final boolean hasReferenceMaterials()For responses, this returns true if the service returned a value for the ReferenceMaterials property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReferenceMaterials()method.- Returns:
- 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.
-
createdAt
-
updatedAt
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CampaignTemplate.Builder,CampaignTemplate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-