Class TextDetection

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

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier ( ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting text in the Amazon Rekognition Developer Guide.

See Also:

  • Method Details

    • detectedText

      public final String detectedText()

      The word or line of text recognized by Amazon Rekognition.

      Returns:
      The word or line of text recognized by Amazon Rekognition.

    • type

      public final TextTypes type()

      The type of text that was detected.

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

      Returns:
      The type of text that was detected.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of text that was detected.

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

      Returns:
      The type of text that was detected.
      See Also:

    • id

      public final Integer id()

      The identifier for the detected text. The identifier is only unique for a single call to DetectText.

      Returns:
      The identifier for the detected text. The identifier is only unique for a single call to DetectText.

    • parentId

      public final Integer parentId()

      The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

      Returns:
      The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

    • confidence

      public final Float confidence()

      The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

      Returns:
      The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

    • geometry

      public final Geometry geometry()

      The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

      Returns:
      The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

    • toBuilder

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

    • builder

      public static TextDetection.Builder builder()

    • serializableBuilderClass

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