Class CampaignTemplate

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

@Generated("software.amazon.awssdk:codegen") public final class CampaignTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CampaignTemplate.Builder,CampaignTemplate>

A platform-managed campaign template — an AWS-authored kit of asset blueprints a partner creates a campaign from.

See Also:
  • Method Details

    • id

      public final String id()

      The campaign template identifier.

      Returns:
      The campaign template identifier.
    • name

      public final String name()

      The display name.

      Returns:
      The display name.
    • industry

      public final Industry industry()

      Target industry for filtering or categorization.

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

      Returns:
      Target industry for filtering or categorization.
      See Also:
    • industryAsString

      public final String industryAsString()

      Target industry for filtering or categorization.

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

      Returns:
      Target industry for filtering or categorization.
      See Also:
    • useCase

      public final String useCase()

      Campaign use case for filtering or categorization.

      Returns:
      Campaign use case for filtering or categorization.
    • description

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

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

      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

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

      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

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

      Returns:
      The browsing context the template is listed in. Every template has exactly one.
      See Also:
    • collectionAsString

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

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

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

      public final List<CustomerSegment> customerSegments()

      The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search 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 CustomerSegments search 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 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.
    • customerSegmentsAsStrings

      public final List<String> customerSegmentsAsStrings()

      The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search 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 CustomerSegments search filter.
    • themes

      public final List<Theme> themes()

      The template's marketing themes. Absent when the template names none, in which case it matches every Themes search 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 Themes search 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 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.
    • themesAsStrings

      public final List<String> themesAsStrings()

      The template's marketing themes. Absent when the template names none, in which case it matches every Themes search 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 Themes search filter.
    • setupDuration

      public final String setupDuration()

      Estimated setup time.

      Returns:
      Estimated setup time.
    • thumbnailUrl

      public final String thumbnailUrl()

      Thumbnail URL.

      Returns:
      Thumbnail URL.
    • effectiveDateBegin

      public final Instant 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 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.
    • assetTemplates

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

      public final List<ReferenceMaterial> 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 AssetTemplates because none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited a BatchCreateCampaignAsset that 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 AssetTemplates because none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited a BatchCreateCampaignAsset that could only fail.

      Absent when the template has none.

    • createdAt

      public final Instant createdAt()

      Creation timestamp.

      Returns:
      Creation timestamp.
    • updatedAt

      public final Instant updatedAt()

      Last update timestamp.

      Returns:
      Last update timestamp.
    • toBuilder

      public CampaignTemplate.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<CampaignTemplate.Builder,CampaignTemplate>
      Returns:
      a builder for type T
    • builder

      public static CampaignTemplate.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CampaignTemplate.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.