software.amazon.awssdk.services.comprehendmedical.model

Class Attribute

java.lang.Object

software.amazon.awssdk.services.comprehendmedical.model.Attribute

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Attribute.Builder,Attribute>

@Generated(value="software.amazon.awssdk:codegen")
public final class Attribute
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Attribute.Builder,Attribute>

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. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Attribute.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() The 0-based character offset in the input text that shows where the attribute begins.
static Attribute.Builder	builder()
Integer	endOffset() The 0-based character offset in the input text that shows where the attribute ends.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	id() The numeric identifier for this attribute.
Float	relationshipScore() The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
Float	score() The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends Attribute.Builder>	serializableBuilderClass()
String	text() The segment of input text extracted as this attribute.
Attribute.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<Trait>	traits() Contextual information for this attribute.
EntitySubType	type() The type of attribute.
String	typeAsString() The type of attribute.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public EntitySubType type()

The type of attribute.

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

Returns:

The type of attribute.

See Also:

EntitySubType

typeAsString

public String typeAsString()

The type of attribute.

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

Returns:

The type of attribute.

See Also:

EntitySubType

score

public Float score()

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

Returns:

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

relationshipScore

public Float relationshipScore()

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

Returns:

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

id

public 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 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 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 String text()

The segment of input text extracted as this attribute.

Returns:

The segment of input text extracted as this attribute.

traits

public List<Trait> traits()

Contextual information for this attribute.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Contextual information for this attribute.

toBuilder

public Attribute.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Attribute.Builder,Attribute>

Returns:

a builder for type T

builder

public static Attribute.Builder builder()

serializableBuilderClass

public static Class<? extends Attribute.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.