com.amazonaws.services.comprehend.model

Class BatchItemError

java.lang.Object

com.amazonaws.services.comprehend.model.BatchItemError

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchItemError()

Method Summary

Modifier and Type	Method and Description
BatchItemError	clone()
boolean	equals(Object obj)
String	getErrorCode() The numeric error code of the error.
String	getErrorMessage() A text description of the error.
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	setErrorCode(String errorCode) The numeric error code of the error.
void	setErrorMessage(String errorMessage) A text description of the error.
void	setIndex(Integer index) The zero-based index of the document in the input list.
String	toString() Returns a string representation of this object.
BatchItemError	withErrorCode(String errorCode) The numeric error code of the error.
BatchItemError	withErrorMessage(String errorMessage) A text description of the error.
BatchItemError	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

BatchItemError

public BatchItemError()

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

setErrorCode

public void setErrorCode(String errorCode)

The numeric error code of the error.

Parameters:

errorCode - The numeric error code of the error.

getErrorCode

public String getErrorCode()

The numeric error code of the error.

Returns:

The numeric error code of the error.

withErrorCode

public BatchItemError withErrorCode(String errorCode)

The numeric error code of the error.

Parameters:

errorCode - The numeric error code of the error.

Returns:

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

setErrorMessage

public void setErrorMessage(String errorMessage)

A text description of the error.

Parameters:

errorMessage - A text description of the error.

getErrorMessage

public String getErrorMessage()

A text description of the error.

Returns:

A text description of the error.

withErrorMessage

public BatchItemError withErrorMessage(String errorMessage)

A text description of the error.

Parameters:

errorMessage - A text description of the error.

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