Class CampaignAssetTemplate
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CampaignAssetTemplate.Builder,CampaignAssetTemplate>
One asset blueprint inside a campaign template. The id is template-local — an asset template is not a standalone resource and has no ARN.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final IntegerOrdering for preview and instantiation.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List<CampaignAssetTemplateField> fields()The editable-field schema, copied and pinned onto each campaign asset at create.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the Fields property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the LayoutPreviews property.final booleanFor responses, this returns true if the service returned a value for the PrerequisiteAssetTemplateIds property.final Stringid()The template-local asset template identifier.final Stringlabel()Display label; becomes the instantiated asset's name.final List<LayoutPreview> Previews of the AWS-authored layout skeleton.The asset templates this one embeds output from, such as an email's landing page.static Class<? extends CampaignAssetTemplate.Builder> final PlatformSOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports asSocialPlatform.final StringSOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports asSocialPlatform.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.type()The kind of asset this blueprint instantiates as.final StringThe kind of asset this blueprint instantiates as.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The template-local asset template identifier.
- Returns:
- The template-local asset template identifier.
-
type
The kind of asset this blueprint instantiates as.
If the service returns an enum value that is not available in the current SDK version,
typewill returnCampaignAssetTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The kind of asset this blueprint instantiates as.
- See Also:
-
typeAsString
The kind of asset this blueprint instantiates as.
If the service returns an enum value that is not available in the current SDK version,
typewill returnCampaignAssetTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The kind of asset this blueprint instantiates as.
- See Also:
-
label
Display label; becomes the instantiated asset's name.
- Returns:
- Display label; becomes the instantiated asset's name.
-
displayOrder
Ordering for preview and instantiation.
- Returns:
- Ordering for preview and instantiation.
-
hasFields
public final boolean hasFields()For responses, this returns true if the service returned a value for the Fields 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. -
fields
The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.
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
hasFields()method.- Returns:
- The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.
-
hasLayoutPreviews
public final boolean hasLayoutPreviews()For responses, this returns true if the service returned a value for the LayoutPreviews 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. -
layoutPreviews
Previews of the AWS-authored layout skeleton.
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
hasLayoutPreviews()method.- Returns:
- Previews of the AWS-authored layout skeleton.
-
hasPrerequisiteAssetTemplateIds
public final boolean hasPrerequisiteAssetTemplateIds()For responses, this returns true if the service returned a value for the PrerequisiteAssetTemplateIds 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. -
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.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
hasPrerequisiteAssetTemplateIds()method.- Returns:
- 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.
-
socialPlatformAsString
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.If the service returns an enum value that is not available in the current SDK version,
socialPlatformwill returnPlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsocialPlatformAsString().- Returns:
- 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. - See Also:
-
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<CampaignAssetTemplate.Builder,CampaignAssetTemplate> - 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.
-
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.If the service returns an enum value that is not available in the current SDK version,
socialPlatformwill returnPlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsocialPlatformAsString().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.Platform