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

Class BatchGetDocumentStatusResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetDocumentStatusResponse.Builder,BatchGetDocumentStatusResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetDocumentStatusResponse.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetDocumentStatusResponse.Builder	builder()
List<Status>	documentStatusList()	The status of documents.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<BatchGetDocumentStatusResponseError>	errors()	A list of documents that Amazon Kendra couldn't get the status for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentStatusList()	For responses, this returns true if the service returned a value for the DocumentStatusList property.
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetDocumentStatusResponse.Builder>	serializableBuilderClass()
BatchGetDocumentStatusResponse.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

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors 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.

errors

public final List<BatchGetDocumentStatusResponseError> errors()

A list of documents that Amazon Kendra couldn't get the status for. The list includes the ID of the document and the reason that the status couldn't be found.

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 hasErrors() method.

Returns:

A list of documents that Amazon Kendra couldn't get the status for. The list includes the ID of the document and the reason that the status couldn't be found.

hasDocumentStatusList

public final boolean hasDocumentStatusList()

For responses, this returns true if the service returned a value for the DocumentStatusList 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.

documentStatusList

public final List<Status> documentStatusList()

The status of documents. The status indicates if the document is waiting to be indexed, is in the process of indexing, has completed indexing, or failed indexing. If a document failed indexing, the status provides the reason why.

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 hasDocumentStatusList() method.

Returns:

The status of documents. The status indicates if the document is waiting to be indexed, is in the process of indexing, has completed indexing, or failed indexing. If a document failed indexing, the status provides the reason why.

toBuilder

public BatchGetDocumentStatusResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetDocumentStatusResponse.Builder,BatchGetDocumentStatusResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static BatchGetDocumentStatusResponse.Builder builder()

serializableBuilderClass

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