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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntities() For responses, this returns true if the service returned a value for the Entities property.
int	hashCode()
boolean	hasUnmappedAttributes() For responses, this returns true if the service returned a value for the UnmappedAttributes property.
String	modelVersion() The version of the model used to analyze the documents.
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()
String	toString() Returns a string representation of this object.
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

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

For responses, this returns true if the service returned a value for the Entities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

entities

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntities() method.

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

hasUnmappedAttributes

public final boolean hasUnmappedAttributes()

For responses, this returns true if the service returned a value for the UnmappedAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

unmappedAttributes

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUnmappedAttributes() method.

Returns:

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

paginationToken

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

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 DetectEntitiesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DetectEntitiesResponse.Builder builder()

serializableBuilderClass

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