com.amazonaws.services.comprehend.model

Class BatchItemError

java.lang.Object

com.amazonaws.services.comprehend.model.BatchItemError

All Implemented Interfaces:

java.io.Serializable

public class BatchItemError
extends java.lang.Object
implements java.io.Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchItemError()

Method Summary

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

getIndex

public java.lang.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.

setIndex

public void setIndex(java.lang.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.

withIndex

public BatchItemError withIndex(java.lang.Integer index)

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

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

Parameters:

index -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getErrorCode

public java.lang.String getErrorCode()

The numeric error code of the error.

Constraints:
Length: 1 -

Returns:

The numeric error code of the error.

setErrorCode

public void setErrorCode(java.lang.String errorCode)

The numeric error code of the error.

Constraints:
Length: 1 -

Parameters:

errorCode -

The numeric error code of the error.

withErrorCode

public BatchItemError withErrorCode(java.lang.String errorCode)

The numeric error code of the error.

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

Constraints:
Length: 1 -

Parameters:

errorCode -

The numeric error code of the error.

Returns:

A reference to this updated object so that method calls can be chained together.

getErrorMessage

public java.lang.String getErrorMessage()

A text description of the error.

Constraints:
Length: 1 -

Returns:

A text description of the error.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

A text description of the error.

Constraints:
Length: 1 -

Parameters:

errorMessage -

A text description of the error.

withErrorMessage

public BatchItemError withErrorMessage(java.lang.String errorMessage)

A text description of the error.

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

Constraints:
Length: 1 -

Parameters:

errorMessage -

A text description of the error.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object