software.amazon.awssdk.services.comprehendmedical.model

Interface SNOMEDCTAttribute.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>, SdkBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>, SdkPojo

Enclosing class:

SNOMEDCTAttribute

public static interface SNOMEDCTAttribute.Builder
extends SdkPojo, CopyableBuilder<SNOMEDCTAttribute.Builder,SNOMEDCTAttribute>

Method Summary

Modifier and Type	Method and Description
SNOMEDCTAttribute.Builder	beginOffset(Integer beginOffset) The 0-based character offset in the input text that shows where the attribute begins.
SNOMEDCTAttribute.Builder	category(SNOMEDCTEntityCategory category) The category of the detected attribute.
SNOMEDCTAttribute.Builder	category(String category) The category of the detected attribute.
SNOMEDCTAttribute.Builder	endOffset(Integer endOffset) The 0-based character offset in the input text that shows where the attribute ends.
SNOMEDCTAttribute.Builder	id(Integer id) The numeric identifier for this attribute.
SNOMEDCTAttribute.Builder	relationshipScore(Float relationshipScore) The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
SNOMEDCTAttribute.Builder	relationshipType(SNOMEDCTRelationshipType relationshipType) The type of relationship that exists between the entity and the related attribute.
SNOMEDCTAttribute.Builder	relationshipType(String relationshipType) The type of relationship that exists between the entity and the related attribute.
SNOMEDCTAttribute.Builder	score(Float score) The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
SNOMEDCTAttribute.Builder	snomedctConcepts(Collection<SNOMEDCTConcept> snomedctConcepts) The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
SNOMEDCTAttribute.Builder	snomedctConcepts(Consumer<SNOMEDCTConcept.Builder>... snomedctConcepts) The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
SNOMEDCTAttribute.Builder	snomedctConcepts(SNOMEDCTConcept... snomedctConcepts) The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
SNOMEDCTAttribute.Builder	text(String text) The segment of input text extracted as this attribute.
SNOMEDCTAttribute.Builder	traits(Collection<SNOMEDCTTrait> traits) Contextual information for an attribute.
SNOMEDCTAttribute.Builder	traits(Consumer<SNOMEDCTTrait.Builder>... traits) Contextual information for an attribute.
SNOMEDCTAttribute.Builder	traits(SNOMEDCTTrait... traits) Contextual information for an attribute.
SNOMEDCTAttribute.Builder	type(SNOMEDCTAttributeType type) The type of attribute.
SNOMEDCTAttribute.Builder	type(String type) The type of attribute.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

category

SNOMEDCTAttribute.Builder category(String category)

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

Parameters:

category - The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTEntityCategory, SNOMEDCTEntityCategory

category

SNOMEDCTAttribute.Builder category(SNOMEDCTEntityCategory category)

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

Parameters:

category - The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTEntityCategory, SNOMEDCTEntityCategory

type

SNOMEDCTAttribute.Builder type(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTAttributeType, SNOMEDCTAttributeType

type

SNOMEDCTAttribute.Builder type(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTAttributeType, SNOMEDCTAttributeType

score

SNOMEDCTAttribute.Builder score(Float score)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relationshipScore

SNOMEDCTAttribute.Builder relationshipScore(Float relationshipScore)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relationshipType

SNOMEDCTAttribute.Builder relationshipType(String relationshipType)

The type of relationship that exists between the entity and the related attribute.

Parameters:

relationshipType - The type of relationship that exists between the entity and the related attribute.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTRelationshipType, SNOMEDCTRelationshipType

relationshipType

SNOMEDCTAttribute.Builder relationshipType(SNOMEDCTRelationshipType relationshipType)

The type of relationship that exists between the entity and the related attribute.

Parameters:

relationshipType - The type of relationship that exists between the entity and the related attribute.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SNOMEDCTRelationshipType, SNOMEDCTRelationshipType

id

SNOMEDCTAttribute.Builder id(Integer id)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

beginOffset

SNOMEDCTAttribute.Builder beginOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

endOffset

SNOMEDCTAttribute.Builder endOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

text

SNOMEDCTAttribute.Builder text(String text)

The segment of input text extracted as this attribute.

Parameters:

text - The segment of input text extracted as this attribute.

Returns:

Returns a reference to this object so that method calls can be chained together.

traits

SNOMEDCTAttribute.Builder traits(Collection<SNOMEDCTTrait> traits)

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Parameters:

traits - Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Returns:

Returns a reference to this object so that method calls can be chained together.

traits

SNOMEDCTAttribute.Builder traits(SNOMEDCTTrait... traits)

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Parameters:

traits - Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Returns:

Returns a reference to this object so that method calls can be chained together.

traits

SNOMEDCTAttribute.Builder traits(Consumer<SNOMEDCTTrait.Builder>... traits)

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

This is a convenience method that creates an instance of the SNOMEDCTTrait.Builder avoiding the need to create one manually via SNOMEDCTTrait.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #traits(List).

Parameters:

traits - a consumer that will call methods on SNOMEDCTTrait.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#traits(java.util.Collection)

snomedctConcepts

SNOMEDCTAttribute.Builder snomedctConcepts(Collection<SNOMEDCTConcept> snomedctConcepts)

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Parameters:

snomedctConcepts - The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Returns:

Returns a reference to this object so that method calls can be chained together.

snomedctConcepts

SNOMEDCTAttribute.Builder snomedctConcepts(SNOMEDCTConcept... snomedctConcepts)

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Parameters:

snomedctConcepts - The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Returns:

Returns a reference to this object so that method calls can be chained together.

snomedctConcepts

SNOMEDCTAttribute.Builder snomedctConcepts(Consumer<SNOMEDCTConcept.Builder>... snomedctConcepts)

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

This is a convenience method that creates an instance of the SNOMEDCTConcept.Builder avoiding the need to create one manually via SNOMEDCTConcept.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #snomedctConcepts(List).

Parameters:

snomedctConcepts - a consumer that will call methods on SNOMEDCTConcept.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#snomedctConcepts(java.util.Collection)