DetectPHIResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DetectPHIResult()

Constructors
Constructor and Description
`DetectPHIResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DetectPHIResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<Entity>`	`getEntities()` The collection of PHI 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 `DetectPHI` was truncated, include the `PaginationToken` to fetch the next page of PHI entities.
`int`	`hashCode()`
`void`	`setEntities(Collection<Entity> entities)` The collection of PHI 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 `DetectPHI` was truncated, include the `PaginationToken` to fetch the next page of PHI entities.
`String`	`toString()` Returns a string representation of this object.
`DetectPHIResult`	`withEntities(Collection<Entity> entities)` The collection of PHI entities extracted from the input text and their associated information.
`DetectPHIResult`	`withEntities(Entity... entities)` The collection of PHI entities extracted from the input text and their associated information.
`DetectPHIResult`	`withModelVersion(String modelVersion)` The version of the model used to analyze the documents.
`DetectPHIResult`	`withPaginationToken(String paginationToken)` If the result of the previous request to `DetectPHI` was truncated, include the `PaginationToken` to fetch the next page of PHI entities.

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
  - DetectPHIResult
```
public DetectPHIResult()
```
- Method Detail
  - getEntities
```
public List<Entity> getEntities()
```
    The collection of PHI 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 Comprehend Medical; has in its detection.
    
    Returns:
    
    The collection of PHI 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 Comprehend Medical; has in its detection.
  - setEntities
```
public void setEntities(Collection<Entity> entities)
```
    The collection of PHI 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 Comprehend Medical; has in its detection.
    
    Parameters:
    
    entities - The collection of PHI 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 Comprehend Medical; has in its detection.
  - withEntities
```
public DetectPHIResult withEntities(Entity... entities)
```
    The collection of PHI 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 Comprehend Medical; has in its detection.
    
    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 PHI 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 Comprehend Medical; has in its detection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntities
```
public DetectPHIResult withEntities(Collection<Entity> entities)
```
    The collection of PHI 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 Comprehend Medical; has in its detection.
    
    Parameters:
    
    entities - The collection of PHI 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 Comprehend Medical; has in its detection.
    
    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 DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
    
    Parameters:
    
    paginationToken - If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
  - getPaginationToken
```
public String getPaginationToken()
```
    If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
    
    Returns:
    
    If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
  - withPaginationToken
```
public DetectPHIResult withPaginationToken(String paginationToken)
```
    If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
    
    Parameters:
    
    paginationToken - If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI 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 DetectPHIResult 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 DetectPHIResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DetectPHIResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DetectPHIResult

Method Detail

getEntities

setEntities

withEntities

withEntities

setPaginationToken

getPaginationToken

withPaginationToken

setModelVersion

getModelVersion

withModelVersion

toString

equals

hashCode

clone