Class TextEvent

java.lang.Object
software.amazon.awssdk.services.polly.model.TextEvent
All Implemented Interfaces:
Serializable, SdkPojo, StartSpeechSynthesisStreamActionStream, ToCopyableBuilder<TextEvent.Builder,TextEvent>
Direct Known Subclasses:
DefaultTextEvent
@Generated("software.amazon.awssdk:codegen") public class TextEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TextEvent.Builder,TextEvent>, StartSpeechSynthesisStreamActionStream

Contains text content to be synthesized into speech.

See Also:

  • Method Details

    • text

      public final String text()

      The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

      Returns:
      The text content to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

    • textType

      public final TextType textType()

      Specifies whether the input text is plain text or SSML. Default: plain text.

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

      Returns:
      Specifies whether the input text is plain text or SSML. Default: plain text.
      See Also:

    • textTypeAsString

      public final String textTypeAsString()

      Specifies whether the input text is plain text or SSML. Default: plain text.

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

      Returns:
      Specifies whether the input text is plain text or SSML. Default: plain text.
      See Also:

    • flushStreamConfiguration

      public final FlushStreamConfiguration flushStreamConfiguration()

      Configuration for controlling when synthesized audio flushes to the output stream.

      Returns:
      Configuration for controlling when synthesized audio flushes to the output stream.

    • toBuilder

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

    • builder

      public static TextEvent.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final TextEvent copy(Consumer<? super TextEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<TextEvent.Builder,TextEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

    • 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.