Package software.amazon.awssdk.services.qbusiness.model

Class FailedDocument

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.FailedDocument

All Implemented Interfaces:

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

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

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FailedDocument.Builder

Method Summary

Modifier and Type	Method	Description
static FailedDocument.Builder	builder()
String	dataSourceId()	The identifier of the Amazon Q Business data source connector that contains the failed document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorDetail	error()	An explanation for why the document couldn't be removed from the index.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the document that couldn't be removed from the Amazon Q Business index.
List<SdkField<?>>	sdkFields()
static Class<? extends FailedDocument.Builder>	serializableBuilderClass()
FailedDocument.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

id

public final String id()

The identifier of the document that couldn't be removed from the Amazon Q Business index.

Returns:

The identifier of the document that couldn't be removed from the Amazon Q Business index.

error

public final ErrorDetail error()

An explanation for why the document couldn't be removed from the index.

Returns:

An explanation for why the document couldn't be removed from the index.

dataSourceId

public final String dataSourceId()

The identifier of the Amazon Q Business data source connector that contains the failed document.

Returns:

The identifier of the Amazon Q Business data source connector that contains the failed document.

toBuilder

public FailedDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FailedDocument.Builder,FailedDocument>

builder

public static FailedDocument.Builder builder()

serializableBuilderClass

public static Class<? extends FailedDocument.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