Package software.amazon.awssdk.services.kendra.model

Class BatchPutDocumentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.BatchPutDocumentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchPutDocumentResponse.Builder,BatchPutDocumentResponse>

@Generated("software.amazon.awssdk:codegen")
public final class BatchPutDocumentResponse
extends KendraResponse
implements ToCopyableBuilder<BatchPutDocumentResponse.Builder,BatchPutDocumentResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchPutDocumentResponse.Builder

Method Summary

Modifier and Type	Method	Description
static BatchPutDocumentResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<BatchPutDocumentResponseFailedDocument>	failedDocuments()	A list of documents that were not added to the index because the document failed a validation check.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailedDocuments()	For responses, this returns true if the service returned a value for the FailedDocuments property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BatchPutDocumentResponse.Builder>	serializableBuilderClass()
BatchPutDocumentResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasFailedDocuments

public final boolean hasFailedDocuments()

For responses, this returns true if the service returned a value for the FailedDocuments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

failedDocuments

public final List<BatchPutDocumentResponseFailedDocument> failedDocuments()

A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch logs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailedDocuments() method.

Returns:

A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch logs.

toBuilder

public BatchPutDocumentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchPutDocumentResponse.Builder,BatchPutDocumentResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static BatchPutDocumentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo