Class TextPartValue

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

Describes text information objects containing fields that determine how text part objects are composed.

See Also:

  • Method Details

    • type

      public final TextPartType type()

      The type of text part. Determines the usage of all other fields and whether or not they're required.

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

      Returns:
      The type of text part. Determines the usage of all other fields and whether or not they're required.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of text part. Determines the usage of all other fields and whether or not they're required.

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

      Returns:
      The type of text part. Determines the usage of all other fields and whether or not they're required.
      See Also:

    • displayText

      public final String displayText()

      A short single line description of the link. Must be hyper-linked with the URL itself.

      Used for text parts with the type URL.

      Returns:
      A short single line description of the link. Must be hyper-linked with the URL itself.

      Used for text parts with the type URL.

    • textByLocale

      public final Map<LocaleCode,String> textByLocale()

      A map of locales to the text in that locale.

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

      Returns:
      A map of locales to the text in that locale.

    • hasTextByLocale

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

    • textByLocaleAsStrings

      public final Map<String,String> textByLocaleAsStrings()

      A map of locales to the text in that locale.

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

      Returns:
      A map of locales to the text in that locale.

    • url

      public final String url()

      The URL itself.

      Returns:
      The URL itself.

    • toBuilder

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

    • builder

      public static TextPartValue.Builder builder()

    • serializableBuilderClass

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