Attribute (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Attribute
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Attribute()

Constructors
Constructor and Description
`Attribute()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Attribute`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBeginOffset()` The 0-based character offset in the input text that shows where the attribute begins.
`Integer`	`getEndOffset()` The 0-based character offset in the input text that shows where the attribute ends.
`Integer`	`getId()` The numeric identifier for this attribute.
`Float`	`getRelationshipScore()` The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
`Float`	`getScore()` The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`String`	`getText()` The segment of input text extracted as this attribute.
`List<Trait>`	`getTraits()` Contextual information for this attribute.
`String`	`getType()` The type of attribute.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the attribute begins.
`void`	`setEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the attribute ends.
`void`	`setId(Integer id)` The numeric identifier for this attribute.
`void`	`setRelationshipScore(Float relationshipScore)` The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
`void`	`setScore(Float score)` The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`void`	`setText(String text)` The segment of input text extracted as this attribute.
`void`	`setTraits(Collection<Trait> traits)` Contextual information for this attribute.
`void`	`setType(String type)` The type of attribute.
`String`	`toString()` Returns a string representation of this object.
`Attribute`	`withBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the attribute begins.
`Attribute`	`withEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the attribute ends.
`Attribute`	`withId(Integer id)` The numeric identifier for this attribute.
`Attribute`	`withRelationshipScore(Float relationshipScore)` The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
`Attribute`	`withScore(Float score)` The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`Attribute`	`withText(String text)` The segment of input text extracted as this attribute.
`Attribute`	`withTraits(Collection<Trait> traits)` Contextual information for this attribute.
`Attribute`	`withTraits(Trait... traits)` Contextual information for this attribute.
`Attribute`	`withType(EntitySubType type)` The type of attribute.
`Attribute`	`withType(String type)` The type of attribute.

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

- Constructor Detail
  - Attribute
```
public Attribute()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of attribute.
    
    Parameters:
    
    type - The type of attribute.
    
    See Also:
    
    EntitySubType
  - getType
```
public String getType()
```
    The type of attribute.
    
    Returns:
    
    The type of attribute.
    
    See Also:
    
    EntitySubType
  - withType
```
public Attribute withType(String type)
```
    The type of attribute.
    
    Parameters:
    
    type - The type of attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntitySubType
  - withType
```
public Attribute withType(EntitySubType type)
```
    The type of attribute.
    
    Parameters:
    
    type - The type of attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntitySubType
  - setScore
```
public void setScore(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.
  - getScore
```
public Float getScore()
```
    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.
  - withScore
```
public Attribute withScore(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.
  - setRelationshipScore
```
public void setRelationshipScore(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.
  - getRelationshipScore
```
public Float getRelationshipScore()
```
    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.
  - withRelationshipScore
```
public Attribute withRelationshipScore(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.
  - setId
```
public void setId(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.
  - getId
```
public Integer getId()
```
    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.
  - withId
```
public Attribute withId(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.
  - setBeginOffset
```
public void setBeginOffset(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.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    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.
  - withBeginOffset
```
public Attribute withBeginOffset(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.
  - setEndOffset
```
public void setEndOffset(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.
  - getEndOffset
```
public Integer getEndOffset()
```
    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.
  - withEndOffset
```
public Attribute withEndOffset(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.
  - setText
```
public void setText(String text)
```
    The segment of input text extracted as this attribute.
    
    Parameters:
    
    text - The segment of input text extracted as this attribute.
  - getText
```
public String getText()
```
    The segment of input text extracted as this attribute.
    
    Returns:
    
    The segment of input text extracted as this attribute.
  - withText
```
public Attribute withText(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.
  - getTraits
```
public List<Trait> getTraits()
```
    Contextual information for this attribute.
    
    Returns:
    
    Contextual information for this attribute.
  - setTraits
```
public void setTraits(Collection<Trait> traits)
```
    Contextual information for this attribute.
    
    Parameters:
    
    traits - Contextual information for this attribute.
  - withTraits
```
public Attribute withTraits(Trait... traits)
```
    Contextual information for this attribute.
    
    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 this attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTraits
```
public Attribute withTraits(Collection<Trait> traits)
```
    Contextual information for this attribute.
    
    Parameters:
    
    traits - Contextual information for this attribute.
    
    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 Attribute 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 Attribute

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Attribute

Method Detail

setType

getType

withType

withType

setScore

getScore

withScore

setRelationshipScore

getRelationshipScore

withRelationshipScore

setId

getId

withId

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

setText

getText

withText

getTraits

setTraits

withTraits

withTraits

toString

equals

hashCode

clone

marshall