com.amazonaws.services.comprehend.model

Class BatchDetectEntitiesItemResult

java.lang.Object

com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchDetectEntitiesItemResult
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchDetectEntitiesItemResult()

Method Summary

Modifier and Type	Method and Description
BatchDetectEntitiesItemResult	clone()
boolean	equals(Object obj)
List<Entity>	getEntities() One or more Entity objects, one for each entity detected in the document.
Integer	getIndex() The zero-based index of the document in the input list.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEntities(Collection<Entity> entities) One or more Entity objects, one for each entity detected in the document.
void	setIndex(Integer index) The zero-based index of the document in the input list.
String	toString() Returns a string representation of this object.
BatchDetectEntitiesItemResult	withEntities(Collection<Entity> entities) One or more Entity objects, one for each entity detected in the document.
BatchDetectEntitiesItemResult	withEntities(Entity... entities) One or more Entity objects, one for each entity detected in the document.
BatchDetectEntitiesItemResult	withIndex(Integer index) The zero-based index of the document in the input list.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchDetectEntitiesItemResult

public BatchDetectEntitiesItemResult()

Method Detail

setIndex

public void setIndex(Integer index)

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

Parameters:

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

getIndex

public Integer getIndex()

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

Returns:

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

withIndex

public BatchDetectEntitiesItemResult withIndex(Integer index)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getEntities

public List<Entity> getEntities()

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

Returns:

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

setEntities

public void setEntities(Collection<Entity> entities)

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

Parameters:

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

withEntities

public BatchDetectEntitiesItemResult withEntities(Entity... entities)

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

NOTE: This method appends the values to the existing list (if any). Use setEntities(java.util.Collection) or withEntities(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withEntities

public BatchDetectEntitiesItemResult withEntities(Collection<Entity> entities)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchDetectEntitiesItemResult clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.