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

Class Attribute

    • Method Detail

      • score

        public final Float score()

        The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

        Returns:
        The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

      • relationshipScore

        public final Float relationshipScore()

        The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

        Returns:
        The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

      • relationshipType

        public final RelationshipType relationshipType()

        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

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

        Returns:
        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
        See Also:
        RelationshipType

      • relationshipTypeAsString

        public final String relationshipTypeAsString()

        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

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

        Returns:
        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
        See Also:
        RelationshipType

      • id

        public final Integer id()

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

        Returns:
        The numeric identifier for this attribute. 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 attribute 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 attribute 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 attribute 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 attribute ends. The offset returns the UTF-8 code point in the string.

      • text

        public final String text()

        The segment of input text extracted as this attribute.

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

      • categoryAsString

        public final String categoryAsString()

        The category of attribute.

        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 attribute.
        See Also:
        EntityType

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

        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 this attribute.

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