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(value="software.amazon.awssdk:codegen")
public final class BatchPutDocumentResponse
extends KendraResponse
implements ToCopyableBuilder<BatchPutDocumentResponse.Builder,BatchPutDocumentResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchPutDocumentResponse.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the FailedDocuments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 boolean hasFailedDocuments()

Returns true if the FailedDocuments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

failedDocuments

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

You can use hasFailedDocuments() to see if a value was sent in this field.

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 AWS 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>

Overrides:

toBuilder in class AwsResponse

builder

public static BatchPutDocumentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo