Package software.amazon.awssdk.services.comprehend.model

Class BatchDetectEntitiesItemResult

java.lang.Object

software.amazon.awssdk.services.comprehend.model.BatchDetectEntitiesItemResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchDetectEntitiesItemResult.Builder,BatchDetectEntitiesItemResult>

@Generated("software.amazon.awssdk:codegen")
public final class BatchDetectEntitiesItemResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchDetectEntitiesItemResult.Builder,BatchDetectEntitiesItemResult>

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchDetectEntitiesItemResult.Builder

Method Summary

Modifier and Type	Method	Description
static BatchDetectEntitiesItemResult.Builder	builder()
List<Entity>	entities()	One or more Entity objects, one for each entity detected in the document.
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()
Integer	index()	The zero-based index of the document in the input list.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDetectEntitiesItemResult.Builder>	serializableBuilderClass()
BatchDetectEntitiesItemResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

index

public final Integer index()

The zero-based index of the document in the input list.

Returns:

The zero-based index of the document in the input list.

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

One or more Entity objects, one for each entity detected in the document.

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:

One or more Entity objects, one for each entity detected in the document.

toBuilder

public BatchDetectEntitiesItemResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDetectEntitiesItemResult.Builder,BatchDetectEntitiesItemResult>

builder

public static BatchDetectEntitiesItemResult.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo