Package software.amazon.awssdk.services.comprehendmedical.model

Class Entity

    • Method Detail

      • id

        public final Integer id()

        The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

        Returns:
        The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

      • beginOffset

        public final Integer beginOffset()

        The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

        Returns:
        The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

      • endOffset

        public final Integer endOffset()

        The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

        Returns:
        The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

      • score

        public final Float score()

        The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

        Returns:
        The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

      • text

        public final String text()

        The segment of input text extracted as this entity.

        Returns:
        The segment of input text extracted as this entity.

      • categoryAsString

        public final String categoryAsString()

        The category of the entity.

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

        Returns:
        The category of the entity.
        See Also:
        EntityType

      • type

        public final EntitySubType type()

        Describes the specific type of entity with category of entities.

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

        Returns:
        Describes the specific type of entity with category of entities.
        See Also:
        EntitySubType

      • typeAsString

        public final String typeAsString()

        Describes the specific type of entity with category of entities.

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

        Returns:
        Describes the specific type of entity with category of entities.
        See Also:
        EntitySubType

      • hasTraits

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

      • traits

        public final List<Trait> traits()

        Contextual information for the entity.

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

        Returns:
        Contextual information for the entity.

      • hasAttributes

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

      • attributes

        public final List<Attribute> attributes()

        The extracted attributes that relate to this entity.

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

        Returns:
        The extracted attributes that relate to this entity.

      • serializableBuilderClass

        public static Class<? extends Entity.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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