Class CampaignAssetTemplate

java.lang.Object
software.amazon.awssdk.services.partnercentralmarketing.model.CampaignAssetTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CampaignAssetTemplate.Builder,CampaignAssetTemplate>

@Generated("software.amazon.awssdk:codegen") public final class CampaignAssetTemplate extends Object implements SdkPojo, Serializable, 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:
  • Method Details

    • id

      public final String id()

      The template-local asset template identifier.

      Returns:
      The template-local asset template identifier.
    • type

      public final CampaignAssetTemplateType 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, type will return CampaignAssetTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The kind of asset this blueprint instantiates as.
      See Also:
    • typeAsString

      public final String 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, type will return CampaignAssetTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The kind of asset this blueprint instantiates as.
      See Also:
    • label

      public final String label()

      Display label; becomes the instantiated asset's name.

      Returns:
      Display label; becomes the instantiated asset's name.
    • displayOrder

      public final Integer 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 the isEmpty() 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

      public final List<CampaignAssetTemplateField> 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 the isEmpty() 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

      public final List<LayoutPreview> 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 the isEmpty() 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

      public final List<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.

      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 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.
    • socialPlatform

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, socialPlatform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from socialPlatformAsString().

      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:
    • socialPlatformAsString

      public final String 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, socialPlatform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from socialPlatformAsString().

      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

      public CampaignAssetTemplate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CampaignAssetTemplate.Builder,CampaignAssetTemplate>
      Returns:
      a builder for type T
    • builder

      public static CampaignAssetTemplate.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CampaignAssetTemplate.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.