Entity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehendmedical.model.Entity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Entity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about an extracted medical entity.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`clone()`
`boolean`	`equals(Object obj)`
`List<Attribute>`	`getAttributes()` The extracted attributes that relate to this entity.
`Integer`	`getBeginOffset()` The 0-based character offset in the input text that shows where the entity begins.
`String`	`getCategory()` The category of the entity.
`Integer`	`getEndOffset()` The 0-based character offset in the input text that shows where the entity ends.
`Integer`	`getId()` The numeric identifier for the entity.
`Float`	`getScore()` The level of confidence that Comprehend Medical; has in the accuracy of the detection.
`String`	`getText()` The segment of input text extracted as this entity.
`List<Trait>`	`getTraits()` Contextual information for the entity.
`String`	`getType()` Describes the specific type of entity with category of entities.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Collection<Attribute> attributes)` The extracted attributes that relate to this entity.
`void`	`setBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`void`	`setCategory(String category)` The category of the entity.
`void`	`setEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`void`	`setId(Integer id)` The numeric identifier for the entity.
`void`	`setScore(Float score)` The level of confidence that Comprehend Medical; has in the accuracy of the detection.
`void`	`setText(String text)` The segment of input text extracted as this entity.
`void`	`setTraits(Collection<Trait> traits)` Contextual information for the entity.
`void`	`setType(String type)` Describes the specific type of entity with category of entities.
`String`	`toString()` Returns a string representation of this object.
`Entity`	`withAttributes(Attribute... attributes)` The extracted attributes that relate to this entity.
`Entity`	`withAttributes(Collection<Attribute> attributes)` The extracted attributes that relate to this entity.
`Entity`	`withBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`Entity`	`withCategory(EntityType category)` The category of the entity.
`Entity`	`withCategory(String category)` The category of the entity.
`Entity`	`withEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`Entity`	`withId(Integer id)` The numeric identifier for the entity.
`Entity`	`withScore(Float score)` The level of confidence that Comprehend Medical; has in the accuracy of the detection.
`Entity`	`withText(String text)` The segment of input text extracted as this entity.
`Entity`	`withTraits(Collection<Trait> traits)` Contextual information for the entity.
`Entity`	`withTraits(Trait... traits)` Contextual information for the entity.
`Entity`	`withType(EntitySubType type)` Describes the specific type of entity with category of entities.
`Entity`	`withType(String type)` Describes the specific type of entity with category of entities.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - setId
```
public void setId(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.
  - getId
```
public Integer getId()
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - withId
```
public Entity withId(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.
  - setBeginOffset
```
public void setBeginOffset(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.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    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:
    
    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.
  - withBeginOffset
```
public Entity withBeginOffset(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.
  - setEndOffset
```
public void setEndOffset(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.
  - getEndOffset
```
public Integer getEndOffset()
```
    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:
    
    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.
  - withEndOffset
```
public Entity withEndOffset(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.
  - setScore
```
public void setScore(Float score)
```
    The level of confidence that Comprehend Medical; has in the accuracy of the detection.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical; has in the accuracy of the detection.
  - getScore
```
public Float getScore()
```
    The level of confidence that Comprehend Medical; has in the accuracy of the detection.
    
    Returns:
    
    The level of confidence that Comprehend Medical; has in the accuracy of the detection.
  - withScore
```
public Entity withScore(Float score)
```
    The level of confidence that Comprehend Medical; has in the accuracy of the detection.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical; has in the accuracy of the detection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The segment of input text extracted as this entity.
    
    Parameters:
    
    text - The segment of input text extracted as this entity.
  - getText
```
public String getText()
```
    The segment of input text extracted as this entity.
    
    Returns:
    
    The segment of input text extracted as this entity.
  - withText
```
public Entity withText(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.
  - setCategory
```
public void setCategory(String category)
```
    The category of the entity.
    
    Parameters:
    
    category - The category of the entity.
    
    See Also:
    
    EntityType
  - getCategory
```
public String getCategory()
```
    The category of the entity.
    
    Returns:
    
    The category of the entity.
    
    See Also:
    
    EntityType
  - withCategory
```
public Entity withCategory(String category)
```
    The category of the entity.
    
    Parameters:
    
    category - The category of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - withCategory
```
public Entity withCategory(EntityType category)
```
    The category of the entity.
    
    Parameters:
    
    category - The category of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - setType
```
public void setType(String type)
```
    Describes the specific type of entity with category of entities.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities.
    
    See Also:
    
    EntitySubType
  - getType
```
public String getType()
```
    Describes the specific type of entity with category of entities.
    
    Returns:
    
    Describes the specific type of entity with category of entities.
    
    See Also:
    
    EntitySubType
  - withType
```
public Entity withType(String type)
```
    Describes the specific type of entity with category of entities.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntitySubType
  - withType
```
public Entity withType(EntitySubType type)
```
    Describes the specific type of entity with category of entities.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntitySubType
  - getTraits
```
public List<Trait> getTraits()
```
    Contextual information for the entity.
    
    Returns:
    
    Contextual information for the entity.
  - setTraits
```
public void setTraits(Collection<Trait> traits)
```
    Contextual information for the entity.
    
    Parameters:
    
    traits - Contextual information for the entity.
  - withTraits
```
public Entity withTraits(Trait... traits)
```
    Contextual information for the entity.
    
    NOTE: This method appends the values to the existing list (if any). Use setTraits(java.util.Collection) or withTraits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    traits - Contextual information for the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTraits
```
public Entity withTraits(Collection<Trait> 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.
  - getAttributes
```
public List<Attribute> getAttributes()
```
    The extracted attributes that relate to this entity.
    
    Returns:
    
    The extracted attributes that relate to this entity.
  - setAttributes
```
public void setAttributes(Collection<Attribute> attributes)
```
    The extracted attributes that relate to this entity.
    
    Parameters:
    
    attributes - The extracted attributes that relate to this entity.
  - withAttributes
```
public Entity withAttributes(Attribute... attributes)
```
    The extracted attributes that relate to this entity.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attributes - The extracted attributes that relate to this entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributes
```
public Entity withAttributes(Collection<Attribute> attributes)
```
    The extracted attributes that relate to this entity.
    
    Parameters:
    
    attributes - The extracted attributes that relate to this entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Method Detail

setId

getId

withId

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

setScore

getScore

withScore

setText

getText

withText

setCategory

getCategory

withCategory

withCategory

setType

getType

withType

withType

getTraits

setTraits

withTraits

withTraits

getAttributes

setAttributes

withAttributes

withAttributes

toString

equals

hashCode

clone

marshall