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()
EntityType	category() The category of attribute.
String	categoryAsString() The category of 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	hasTraits() Returns true if the Traits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
RelationshipType	relationshipType() The type of relationship between the entity and attribute.
String	relationshipTypeAsString() The type of relationship between the entity and 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 Attribute.Builder>	serializableBuilderClass()
String	text() The segment of input text extracted as this attribute.
Attribute.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public final 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 final 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 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 RelationshipType relationshipType()

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

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

Returns:

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

See Also:

RelationshipType

relationshipTypeAsString

public final String relationshipTypeAsString()

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

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

Returns:

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

See Also:

RelationshipType

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.

category

public final EntityType category()

The category of attribute.

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

Returns:

The category of attribute.

See Also:

EntityType

categoryAsString

public final String categoryAsString()

The category of attribute.

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

Returns:

The category of attribute.

See Also:

EntityType

hasTraits

public final boolean hasTraits()

Returns true if the Traits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

traits

public final List<Trait> traits()

Contextual information for this attribute.

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

You can use hasTraits() to see if a value was sent in this field.

Returns:

Contextual information for this attribute.

toBuilder

public Attribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Attribute.Builder,Attribute>

builder

public static Attribute.Builder builder()

serializableBuilderClass

public static Class<? extends Attribute.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