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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>
```
@Generated("software.amazon.awssdk:codegen")
public final class SNOMEDCTAttribute
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>
```
The extracted attributes that relate to an entity. 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SNOMEDCTAttribute.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`beginOffset()`	The 0-based character offset in the input text that shows where the attribute begins.
`static SNOMEDCTAttribute.Builder`	`builder()`
`SNOMEDCTEntityCategory`	`category()`	The category of the detected attribute.
`String`	`categoryAsString()`	The category of the detected attribute.
`Integer`	`endOffset()`	The 0-based character offset in the input text that shows where the attribute ends.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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 this attribute.
`Float`	`relationshipScore()`	The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
`SNOMEDCTRelationshipType`	`relationshipType()`	The type of relationship that exists between the entity and the related attribute.
`String`	`relationshipTypeAsString()`	The type of relationship that exists between the entity and the related attribute.
`Float`	`score()`	The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SNOMEDCTAttribute.Builder>`	`serializableBuilderClass()`
`List<SNOMEDCTConcept>`	`snomedctConcepts()`	The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
`String`	`text()`	The segment of input text extracted as this attribute.
`SNOMEDCTAttribute.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<SNOMEDCTTrait>`	`traits()`	Contextual information for an attribute.
`SNOMEDCTAttributeType`	`type()`	The type of attribute.
`String`	`typeAsString()`	The type of attribute.

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
  - category
```
public final SNOMEDCTEntityCategory category()
```
    The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and 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 attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - categoryAsString
```
public final String categoryAsString()
```
    The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and 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 attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - type
```
public final SNOMEDCTAttributeType type()
```
    The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SNOMEDCTAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTAttributeType
  - typeAsString
```
public final String typeAsString()
```
    The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SNOMEDCTAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTAttributeType
  - 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 SNOMEDCTRelationshipType relationshipType()
```
    The type of relationship that exists between the entity and the related attribute.
    
    If the service returns an enum value that is not available in the current SDK version, relationshipType will return SNOMEDCTRelationshipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from relationshipTypeAsString().
    
    Returns:
    
    The type of relationship that exists between the entity and the related attribute.
    
    See Also:
    
    SNOMEDCTRelationshipType
  - relationshipTypeAsString
```
public final String relationshipTypeAsString()
```
    The type of relationship that exists between the entity and the related attribute.
    
    If the service returns an enum value that is not available in the current SDK version, relationshipType will return SNOMEDCTRelationshipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from relationshipTypeAsString().
    
    Returns:
    
    The type of relationship that exists between the entity and the related attribute.
    
    See Also:
    
    SNOMEDCTRelationshipType
  - 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.
  - 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 an attribute. Examples include signs, symptoms, diagnosis, and negation.
    
    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 an attribute. Examples include signs, symptoms, diagnosis, and negation.
  - 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-CT concepts specific to an attribute, 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-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
  - toBuilder
```
public SNOMEDCTAttribute.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>
  - builder
```
public static SNOMEDCTAttribute.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SNOMEDCTAttribute.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 SNOMEDCTAttribute

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

category

categoryAsString

type

typeAsString

score

relationshipScore

relationshipType

relationshipTypeAsString

id

beginOffset

endOffset

text

hasTraits

traits

hasSnomedctConcepts

snomedctConcepts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields