DetectEntitiesResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.comprehendmedical.model.DetectEntitiesResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DetectEntitiesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DetectEntitiesResult()

Constructors
Constructor and Description
`DetectEntitiesResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DetectEntitiesResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<Entity>`	`getEntities()` The collection of medical entities extracted from the input text and their associated information.
`String`	`getModelVersion()` The version of the model used to analyze the documents.
`String`	`getPaginationToken()` If the result of the previous request to `DetectEntities` was truncated, include the `PaginationToken` to fetch the next page of entities.
`List<UnmappedAttribute>`	`getUnmappedAttributes()` Attributes extracted from the input text that we were unable to relate to an entity.
`int`	`hashCode()`
`void`	`setEntities(Collection<Entity> entities)` The collection of medical entities extracted from the input text and their associated information.
`void`	`setModelVersion(String modelVersion)` The version of the model used to analyze the documents.
`void`	`setPaginationToken(String paginationToken)` If the result of the previous request to `DetectEntities` was truncated, include the `PaginationToken` to fetch the next page of entities.
`void`	`setUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)` Attributes extracted from the input text that we were unable to relate to an entity.
`String`	`toString()` Returns a string representation of this object.
`DetectEntitiesResult`	`withEntities(Collection<Entity> entities)` The collection of medical entities extracted from the input text and their associated information.
`DetectEntitiesResult`	`withEntities(Entity... entities)` The collection of medical entities extracted from the input text and their associated information.
`DetectEntitiesResult`	`withModelVersion(String modelVersion)` The version of the model used to analyze the documents.
`DetectEntitiesResult`	`withPaginationToken(String paginationToken)` If the result of the previous request to `DetectEntities` was truncated, include the `PaginationToken` to fetch the next page of entities.
`DetectEntitiesResult`	`withUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)` Attributes extracted from the input text that we were unable to relate to an entity.
`DetectEntitiesResult`	`withUnmappedAttributes(UnmappedAttribute... unmappedAttributes)` Attributes extracted from the input text that we were unable to relate to an entity.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DetectEntitiesResult
```
public DetectEntitiesResult()
```
- Method Detail
  - getEntities
```
public List<Entity> getEntities()
```
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    Returns:
    
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
  - setEntities
```
public void setEntities(Collection<Entity> entities)
```
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    Parameters:
    
    entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
  - withEntities
```
public DetectEntitiesResult withEntities(Entity... entities)
```
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    NOTE: This method appends the values to the existing list (if any). Use setEntities(java.util.Collection) or withEntities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntities
```
public DetectEntitiesResult withEntities(Collection<Entity> entities)
```
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    Parameters:
    
    entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUnmappedAttributes
```
public List<UnmappedAttribute> getUnmappedAttributes()
```
    Attributes extracted from the input text that we were unable to relate to an entity.
    
    Returns:
    
    Attributes extracted from the input text that we were unable to relate to an entity.
  - setUnmappedAttributes
```
public void setUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)
```
    Attributes extracted from the input text that we were unable to relate to an entity.
    
    Parameters:
    
    unmappedAttributes - Attributes extracted from the input text that we were unable to relate to an entity.
  - withUnmappedAttributes
```
public DetectEntitiesResult withUnmappedAttributes(UnmappedAttribute... unmappedAttributes)
```
    Attributes extracted from the input text that we were unable to relate to an entity.
    
    NOTE: This method appends the values to the existing list (if any). Use setUnmappedAttributes(java.util.Collection) or withUnmappedAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    unmappedAttributes - Attributes extracted from the input text that we were unable to relate to an entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUnmappedAttributes
```
public DetectEntitiesResult withUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)
```
    Attributes extracted from the input text that we were unable to relate to an entity.
    
    Parameters:
    
    unmappedAttributes - Attributes extracted from the input text that we were unable to relate to an entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPaginationToken
```
public void setPaginationToken(String paginationToken)
```
    If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
    
    Parameters:
    
    paginationToken - If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
  - getPaginationToken
```
public String getPaginationToken()
```
    If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
    
    Returns:
    
    If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
  - withPaginationToken
```
public DetectEntitiesResult withPaginationToken(String paginationToken)
```
    If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
    
    Parameters:
    
    paginationToken - If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelVersion
```
public void setModelVersion(String modelVersion)
```
    The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
    
    Parameters:
    
    modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
  - getModelVersion
```
public String getModelVersion()
```
    The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
    
    Returns:
    
    The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
  - withModelVersion
```
public DetectEntitiesResult withModelVersion(String modelVersion)
```
    The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
    
    Parameters:
    
    modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
    
    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 DetectEntitiesResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.793

Class DetectEntitiesResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DetectEntitiesResult

Method Detail

getEntities

setEntities

withEntities

withEntities

getUnmappedAttributes

setUnmappedAttributes

withUnmappedAttributes

withUnmappedAttributes

setPaginationToken

getPaginationToken

withPaginationToken

setModelVersion

getModelVersion

withModelVersion

toString

equals

hashCode

clone