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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntities() Returns true if the Entities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	modelVersion() The version of the model used to analyze the documents.
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() Returns a string representation of this object.

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

hasEntities

public final boolean hasEntities()

Returns true if the Entities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

entities

public final 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 Amazon Comprehend Medical has in its detection.

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

You can use hasEntities() to see if a value was sent in this field.

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 Amazon Comprehend Medical has in its detection.

paginationToken

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

modelVersion

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

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.

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 final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo