software.amazon.awssdk.services.comprehendmedical.model

Class DetectEntitiesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectEntitiesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DetectEntitiesResponse.Builder	builder()
List<Entity>	entities() The collection of medical entities extracted from the input text and their associated information.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	paginationToken() If the result of the previous request to DetectEntities was truncated, include the Paginationtoken to fetch the next page of entities.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectEntitiesResponse.Builder>	serializableBuilderClass()
DetectEntitiesResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<UnmappedAttribute>	unmappedAttributes() Attributes extracted from the input text that we were unable to relate to an entity.

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

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 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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

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

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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

unmappedAttributes

public List<UnmappedAttribute> unmappedAttributes()

Attributes extracted from the input text that we were unable to relate to an entity.

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

Returns:

Attributes extracted from the input text that we were unable to relate to an entity.

paginationToken

public String paginationToken()

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.

toBuilder

public DetectEntitiesResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DetectEntitiesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DetectEntitiesResponse.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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.