Class MetaLibraryTemplateDefinition

java.lang.Object
software.amazon.awssdk.services.socialmessaging.model.MetaLibraryTemplateDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MetaLibraryTemplateDefinition.Builder,MetaLibraryTemplateDefinition>
@Generated("software.amazon.awssdk:codegen") public final class MetaLibraryTemplateDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetaLibraryTemplateDefinition.Builder,MetaLibraryTemplateDefinition>

Defines the complete structure and content of a template in Meta's library.

See Also:

  • Method Details

    • templateName

      public final String templateName()

      The name of the template.

      Returns:
      The name of the template.

    • templateLanguage

      public final String templateLanguage()

      The language code for the template (for example, en_US).

      Returns:
      The language code for the template (for example, en_US).

    • templateCategory

      public final String templateCategory()

      The category of the template (for example, UTILITY or MARKETING).

      Returns:
      The category of the template (for example, UTILITY or MARKETING).

    • templateTopic

      public final String templateTopic()

      The topic or subject matter of the template.

      Returns:
      The topic or subject matter of the template.

    • templateUseCase

      public final String templateUseCase()

      The intended use case for the template.

      Returns:
      The intended use case for the template.

    • hasTemplateIndustry

      public final boolean hasTemplateIndustry()
      For responses, this returns true if the service returned a value for the TemplateIndustry 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.

    • templateIndustry

      public final List<String> templateIndustry()

      The industries the template is designed for.

      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 hasTemplateIndustry() method.

      Returns:
      The industries the template is designed for.

    • templateHeader

      public final String templateHeader()

      The header text of the template.

      Returns:
      The header text of the template.

    • templateBody

      public final String templateBody()

      The body text of the template.

      Returns:
      The body text of the template.

    • hasTemplateButtons

      public final boolean hasTemplateButtons()
      For responses, this returns true if the service returned a value for the TemplateButtons 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.

    • templateButtons

      public final List<LibraryTemplateButtonList> templateButtons()

      The buttons included in the template.

      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 hasTemplateButtons() method.

      Returns:
      The buttons included in the template.

    • templateId

      public final String templateId()

      The ID of the template in Meta's library.

      Returns:
      The ID of the template in Meta's library.

    • toBuilder

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

    • builder

      public static MetaLibraryTemplateDefinition.Builder builder()

    • serializableBuilderClass

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