Class ExtendedMessageTemplateData

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

The extended data of a message template.

See Also:

  • Method Details

    • messageTemplateArn

      public final String messageTemplateArn()

      The Amazon Resource Name (ARN) of the message template.

      Returns:
      The Amazon Resource Name (ARN) of the message template.

    • messageTemplateId

      public final String messageTemplateId()

      The identifier of the message template.

      Returns:
      The identifier of the message template.

    • knowledgeBaseArn

      public final String knowledgeBaseArn()

      The Amazon Resource Name (ARN) of the knowledge base.

      Returns:
      The Amazon Resource Name (ARN) of the knowledge base.

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The identifier of the knowledge base.

      Returns:
      The identifier of the knowledge base.

    • name

      public final String name()

      The name of the message template.

      Returns:
      The name of the message template.

    • channelSubtype

      public final ChannelSubtype channelSubtype()

      The channel subtype this message template applies to.

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

      Returns:
      The channel subtype this message template applies to.
      See Also:

    • channelSubtypeAsString

      public final String channelSubtypeAsString()

      The channel subtype this message template applies to.

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

      Returns:
      The channel subtype this message template applies to.
      See Also:

    • createdTime

      public final Instant createdTime()

      The timestamp when the message template was created.

      Returns:
      The timestamp when the message template was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when the message template data was last modified.

      Returns:
      The timestamp when the message template data was last modified.

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the user who last updated the message template data.

      Returns:
      The Amazon Resource Name (ARN) of the user who last updated the message template data.

    • content

      public final MessageTemplateContentProvider content()

      The content of the message template.

      Returns:
      The content of the message template.

    • description

      public final String description()

      The description of the message template.

      Returns:
      The description of the message template.

    • language

      public final String language()

      The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

      Returns:
      The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

    • groupingConfiguration

      public final GroupingConfiguration groupingConfiguration()
      Returns the value of the GroupingConfiguration property for this object.
      Returns:
      The value of the GroupingConfiguration property for this object.

    • defaultAttributes

      public final MessageTemplateAttributes defaultAttributes()

      An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

      Returns:
      An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

    • attributeTypes

      public final List<MessageTemplateAttributeType> attributeTypes()

      The types of attributes contain the message 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 hasAttributeTypes() method.

      Returns:
      The types of attributes contain the message template.

    • hasAttributeTypes

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

    • attributeTypesAsStrings

      public final List<String> attributeTypesAsStrings()

      The types of attributes contain the message 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 hasAttributeTypes() method.

      Returns:
      The types of attributes contain the message template.

    • hasAttachments

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

    • attachments

      public final List<MessageTemplateAttachment> attachments()

      The message template attachments.

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

      Returns:
      The message template attachments.

    • isActive

      public final Boolean isActive()

      Whether the version of the message template is activated.

      Returns:
      Whether the version of the message template is activated.

    • versionNumber

      public final Long versionNumber()

      The version number of the message template version.

      Returns:
      The version number of the message template version.

    • messageTemplateContentSha256

      public final String messageTemplateContentSha256()

      The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.

      Returns:
      The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

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

      Returns:
      The tags used to organize, track, or control access for this resource.

    • toBuilder

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

    • builder

      public static ExtendedMessageTemplateData.Builder builder()

    • serializableBuilderClass

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