java.lang.Object
- software.amazon.awssdk.services.comprehendmedical.model.SNOMEDCTEntity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SNOMEDCTEntity.Builder,SNOMEDCTEntity>
```
@Generated("software.amazon.awssdk:codegen")
public final class SNOMEDCTEntity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SNOMEDCTEntity.Builder,SNOMEDCTEntity>
```
The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SNOMEDCTEntity.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<SNOMEDCTAttribute>`	`attributes()`	An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.
`Integer`	`beginOffset()`	The 0-based character offset in the input text that shows where the entity begins.
`static SNOMEDCTEntity.Builder`	`builder()`
`SNOMEDCTEntityCategory`	`category()`	The category of the detected entity.
`String`	`categoryAsString()`	The category of the detected entity.
`Integer`	`endOffset()`	The 0-based character offset in the input text that shows where the entity ends.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasSnomedctConcepts()`	For responses, this returns true if the service returned a value for the SNOMEDCTConcepts property.
`boolean`	`hasTraits()`	For responses, this returns true if the service returned a value for the Traits property.
`Integer`	`id()`	The numeric identifier for the entity.
`Float`	`score()`	The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SNOMEDCTEntity.Builder>`	`serializableBuilderClass()`
`List<SNOMEDCTConcept>`	`snomedctConcepts()`	The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`String`	`text()`	The segment of input text extracted as this entity.
`SNOMEDCTEntity.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<SNOMEDCTTrait>`	`traits()`	Contextual information for the entity.
`SNOMEDCTEntityType`	`type()`	Describes the specific type of entity with category of entities.
`String`	`typeAsString()`	Describes the specific type of entity with category of entities.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- 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.
  - text
```
public final String text()
```
    The segment of input text extracted as this entity.
    
    Returns:
    
    The segment of input text extracted as this entity.
  - category
```
public final SNOMEDCTEntityCategory category()
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    If the service returns an enum value that is not available in the current SDK version, category will return SNOMEDCTEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().
    
    Returns:
    
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - categoryAsString
```
public final String categoryAsString()
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    If the service returns an enum value that is not available in the current SDK version, category will return SNOMEDCTEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().
    
    Returns:
    
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - type
```
public final SNOMEDCTEntityType type()
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SNOMEDCTEntityType.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. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTEntityType
  - typeAsString
```
public final String typeAsString()
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SNOMEDCTEntityType.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. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTEntityType
  - score
```
public final Float score()
```
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
    
    Returns:
    
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
  - 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.
  - 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<SNOMEDCTAttribute> attributes()
```
    An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.
    
    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:
    
    An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.
  - 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<SNOMEDCTTrait> 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.
  - hasSnomedctConcepts
```
public final boolean hasSnomedctConcepts()
```
    For responses, this returns true if the service returned a value for the SNOMEDCTConcepts 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.
  - snomedctConcepts
```
public final List<SNOMEDCTConcept> snomedctConcepts()
```
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    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 hasSnomedctConcepts() method.
    
    Returns:
    
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
  - toBuilder
```
public SNOMEDCTEntity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SNOMEDCTEntity.Builder,SNOMEDCTEntity>
  - builder
```
public static SNOMEDCTEntity.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SNOMEDCTEntity.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class SNOMEDCTEntity

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

text

category

categoryAsString

type

typeAsString

score

beginOffset

endOffset

hasAttributes

attributes

hasTraits

traits

hasSnomedctConcepts

snomedctConcepts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields