software.amazon.awssdk.services.comprehend.model

Class BatchItemError

java.lang.Object

software.amazon.awssdk.services.comprehend.model.BatchItemError

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<BatchItemError.Builder,BatchItemError>

@Generated(value="software.amazon.awssdk:codegen")
public class BatchItemError
extends Object
implements StructuredPojo, ToCopyableBuilder<BatchItemError.Builder,BatchItemError>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchItemError.Builder

Method Summary

Modifier and Type	Method and Description
static BatchItemError.Builder	builder()
boolean	equals(Object obj)
String	errorCode() The numeric error code of the error.
String	errorMessage() A text description of the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	index() The zero-based index of the document in the input list.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends BatchItemError.Builder>	serializableBuilderClass()
BatchItemError.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

index

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

errorCode

public String errorCode()

The numeric error code of the error.

Returns:

The numeric error code of the error.

errorMessage

public String errorMessage()

A text description of the error.

Returns:

A text description of the error.

toBuilder

public BatchItemError.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BatchItemError.Builder,BatchItemError>

Returns:

a builder for type T

builder

public static BatchItemError.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.