Class TemplateVariableMetadata

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

Contains metadata about a template variable.

See Also:

  • Method Details

    • type

      public final TemplateVariableType type()

      The type of the variable.

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

      Returns:
      The type of the variable.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the variable.

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

      Returns:
      The type of the variable.
      See Also:

    • required

      public final Boolean required()

      Whether the variable is required.

      Returns:
      Whether the variable is required.

    • description

      public final String description()

      A description of the variable.

      Returns:
      A description of the variable.

    • maxLength

      public final Integer maxLength()

      The maximum length for string variables.

      Returns:
      The maximum length for string variables.

    • minValue

      public final Integer minValue()

      The minimum value for numeric variables.

      Returns:
      The minimum value for numeric variables.

    • maxValue

      public final Integer maxValue()

      The maximum value for numeric variables.

      Returns:
      The maximum value for numeric variables.

    • defaultValue

      public final String defaultValue()

      The default value for the variable.

      Returns:
      The default value for the variable.

    • pattern

      public final String pattern()

      The regex pattern the variable value must match.

      Returns:
      The regex pattern the variable value must match.

    • sample

      public final String sample()

      A sample value for the variable.

      Returns:
      A sample value for the variable.

    • source

      public final TemplateVariableSource source()

      The source of the variable, either CUSTOMER or SYSTEM.

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

      Returns:
      The source of the variable, either CUSTOMER or SYSTEM.
      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source of the variable, either CUSTOMER or SYSTEM.

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

      Returns:
      The source of the variable, either CUSTOMER or SYSTEM.
      See Also:

    • toBuilder

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

    • builder

      public static TemplateVariableMetadata.Builder builder()

    • serializableBuilderClass

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