Class SyntaxToken

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

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

See Also:

  • Method Details

    • tokenId

      public final Integer tokenId()

      A unique identifier for a token.

      Returns:
      A unique identifier for a token.

    • text

      public final String text()

      The word that was recognized in the source text.

      Returns:
      The word that was recognized in the source text.

    • beginOffset

      public final Integer beginOffset()

      The zero-based offset from the beginning of the source text to the first character in the word.

      Returns:
      The zero-based offset from the beginning of the source text to the first character in the word.

    • endOffset

      public final Integer endOffset()

      The zero-based offset from the beginning of the source text to the last character in the word.

      Returns:
      The zero-based offset from the beginning of the source text to the last character in the word.

    • partOfSpeech

      public final PartOfSpeechTag partOfSpeech()

      Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

      Returns:
      Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

    • toBuilder

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

    • builder

      public static SyntaxToken.Builder builder()

    • serializableBuilderClass

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