software.amazon.awssdk.services.comprehendmedical.model

Class DetectPhiResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalResponse

software.amazon.awssdk.services.comprehendmedical.model.DetectPhiResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectPhiResponse.Builder,DetectPhiResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DetectPhiResponse
extends ComprehendMedicalResponse
implements ToCopyableBuilder<DetectPhiResponse.Builder,DetectPhiResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectPhiResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DetectPhiResponse.Builder	builder()
List<Entity>	entities() The collection of PHI entities extracted from the input text and their associated information.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	paginationToken() If the result of the previous request to DetectPHI was truncated, include the Paginationtoken to fetch the next page of PHI entities.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectPhiResponse.Builder>	serializableBuilderClass()
DetectPhiResponse.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

entities

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

paginationToken

public String paginationToken()

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.

toBuilder

public DetectPhiResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectPhiResponse.Builder,DetectPhiResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DetectPhiResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DetectPhiResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo