Interface SNOMEDCTEntity.Builder

All Superinterfaces:

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

Enclosing class:

SNOMEDCTEntity

@Mutable
@NotThreadSafe
public static interface SNOMEDCTEntity.Builder
extends SdkPojo, CopyableBuilder<SNOMEDCTEntity.Builder,SNOMEDCTEntity>

Method Summary

Modifier and Type	Method	Description
SNOMEDCTEntity.Builder	attributes(Collection<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.
SNOMEDCTEntity.Builder	attributes(Consumer<SNOMEDCTAttribute.Builder>... 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.
SNOMEDCTEntity.Builder	attributes(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.
SNOMEDCTEntity.Builder	beginOffset(Integer beginOffset)	The 0-based character offset in the input text that shows where the entity begins.
SNOMEDCTEntity.Builder	category(String category)	The category of the detected entity.
SNOMEDCTEntity.Builder	category(SNOMEDCTEntityCategory category)	The category of the detected entity.
SNOMEDCTEntity.Builder	endOffset(Integer endOffset)	The 0-based character offset in the input text that shows where the entity ends.
SNOMEDCTEntity.Builder	id(Integer id)	The numeric identifier for the entity.
SNOMEDCTEntity.Builder	score(Float score)	The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
SNOMEDCTEntity.Builder	snomedctConcepts(Collection<SNOMEDCTConcept> snomedctConcepts)	The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
SNOMEDCTEntity.Builder	snomedctConcepts(Consumer<SNOMEDCTConcept.Builder>... snomedctConcepts)	The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
SNOMEDCTEntity.Builder	snomedctConcepts(SNOMEDCTConcept... snomedctConcepts)	The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
SNOMEDCTEntity.Builder	text(String text)	The segment of input text extracted as this entity.
SNOMEDCTEntity.Builder	traits(Collection<SNOMEDCTTrait> traits)	Contextual information for the entity.
SNOMEDCTEntity.Builder	traits(Consumer<SNOMEDCTTrait.Builder>... traits)	Contextual information for the entity.
SNOMEDCTEntity.Builder	traits(SNOMEDCTTrait... traits)	Contextual information for the entity.
SNOMEDCTEntity.Builder	type(String type)	Describes the specific type of entity with category of entities.
SNOMEDCTEntity.Builder	type(SNOMEDCTEntityType type)	Describes the specific type of entity with category of entities.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

SNOMEDCTEntity.Builder id(Integer id)

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

Parameters:

id - The numeric identifier for the entity. 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.

text

SNOMEDCTEntity.Builder text(String text)

The segment of input text extracted as this entity.

Parameters:

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

Returns:

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

category

SNOMEDCTEntity.Builder category(String category)

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

Parameters:

category - The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

Returns:

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

See Also:

• SNOMEDCTEntityCategory
• SNOMEDCTEntityCategory

category

SNOMEDCTEntity.Builder category(SNOMEDCTEntityCategory category)

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

Parameters:

category - The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

Returns:

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

See Also:

• SNOMEDCTEntityCategory
• SNOMEDCTEntityCategory

type

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

Parameters:

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.

Returns:

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

See Also:

• SNOMEDCTEntityType
• SNOMEDCTEntityType

type

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

Parameters:

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.

Returns:

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

See Also:

• SNOMEDCTEntityType
• SNOMEDCTEntityType

score

SNOMEDCTEntity.Builder score(Float score)

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

Parameters:

score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Returns:

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

beginOffset

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

Parameters:

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:

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

endOffset

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

Parameters:

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:

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

attributes

SNOMEDCTEntity.Builder attributes(Collection<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.

Parameters:

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.

Returns:

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

attributes

SNOMEDCTEntity.Builder attributes(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.

Parameters:

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.

Returns:

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

attributes

SNOMEDCTEntity.Builder attributes(Consumer<SNOMEDCTAttribute.Builder>... 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.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributes(List<SNOMEDCTAttribute>).

Parameters:

attributes - a consumer that will call methods on SNOMEDCTAttribute.Builder

Returns:

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

See Also:

• attributes(java.util.Collection<SNOMEDCTAttribute>)

traits

SNOMEDCTEntity.Builder traits(Collection<SNOMEDCTTrait> traits)

Contextual information for the entity.

Parameters:

traits - Contextual information for the entity.

Returns:

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

traits

SNOMEDCTEntity.Builder traits(SNOMEDCTTrait... traits)

Contextual information for the entity.

Parameters:

traits - Contextual information for the entity.

Returns:

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

traits

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

Contextual information for the entity.

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<SNOMEDCTTrait>).

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

snomedctConcepts

SNOMEDCTEntity.Builder snomedctConcepts(Collection<SNOMEDCTConcept> snomedctConcepts)

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Parameters:

snomedctConcepts - The SNOMED concepts that the entity could refer to, 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

SNOMEDCTEntity.Builder snomedctConcepts(SNOMEDCTConcept... snomedctConcepts)

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Parameters:

snomedctConcepts - The SNOMED concepts that the entity could refer to, 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

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

The SNOMED concepts that the entity could refer to, 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<SNOMEDCTConcept>).

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