Class NotifyTemplateInformation

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

The information for a system-managed notify template in an Amazon Web Services account.

See Also:

  • Method Details

    • templateId

      public final String templateId()

      The unique identifier for the template.

      Returns:
      The unique identifier for the template.

    • version

      public final Integer version()

      The version of the template.

      Returns:
      The version of the template.

    • templateType

      public final NotifyTemplateType templateType()

      The type of the template.

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

      Returns:
      The type of the template.
      See Also:

    • templateTypeAsString

      public final String templateTypeAsString()

      The type of the template.

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

      Returns:
      The type of the template.
      See Also:

    • channels

      public final List<NumberCapability> channels()

      The channels for the template. Supported values are SMS and VOICE.

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

      Returns:
      The channels for the template. Supported values are SMS and VOICE.

    • hasChannels

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

    • channelsAsStrings

      public final List<String> channelsAsStrings()

      The channels for the template. Supported values are SMS and VOICE.

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

      Returns:
      The channels for the template. Supported values are SMS and VOICE.

    • tierAccess

      public final List<NotifyConfigurationTier> tierAccess()

      The tier access level for 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 hasTierAccess() method.

      Returns:
      The tier access level for the template.

    • hasTierAccess

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

    • tierAccessAsStrings

      public final List<String> tierAccessAsStrings()

      The tier access level for 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 hasTierAccess() method.

      Returns:
      The tier access level for the template.

    • status

      public final NotifyTemplateStatus status()

      The current status of the template.

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

      Returns:
      The current status of the template.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the template.

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

      Returns:
      The current status of the template.
      See Also:

    • hasSupportedCountries

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

    • supportedCountries

      public final List<String> supportedCountries()

      An array of supported country codes for 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 hasSupportedCountries() method.

      Returns:
      An array of supported country codes for the template.

    • languageCode

      public final String languageCode()

      The language code for the template.

      Returns:
      The language code for the template.

    • content

      public final String content()

      The content of the template.

      Returns:
      The content of the template.

    • hasVariables

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

    • variables

      public final Map<String,TemplateVariableMetadata> variables()

      An array of template variable metadata for 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 hasVariables() method.

      Returns:
      An array of template variable metadata for the template.

    • supportedVoiceIds

      public final List<VoiceId> supportedVoiceIds()

      An array of supported voice IDs for voice templates.

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

      Returns:
      An array of supported voice IDs for voice templates.

    • hasSupportedVoiceIds

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

    • supportedVoiceIdsAsStrings

      public final List<String> supportedVoiceIdsAsStrings()

      An array of supported voice IDs for voice templates.

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

      Returns:
      An array of supported voice IDs for voice templates.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time when the notify template was created, in UNIX epoch time format.

      Returns:
      The time when the notify template was created, in UNIX epoch time format.

    • toBuilder

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

    • builder

      public static NotifyTemplateInformation.Builder builder()

    • serializableBuilderClass

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