com.amazonaws.services.comprehendmedical.model

Class DetectPHIResult

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()

Method Summary

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	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	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	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

finalize, 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.

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