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

Class BatchGetDocumentStatusRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.BatchGetDocumentStatusRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetDocumentStatusRequest.Builder,BatchGetDocumentStatusRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetDocumentStatusRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetDocumentStatusRequest.Builder	builder()
List<DocumentInfo>	documentInfoList()	A list of DocumentInfo objects that identify the documents for which to get the status.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentInfoList()	For responses, this returns true if the service returned a value for the DocumentInfoList property.
int	hashCode()
String	indexId()	The identifier of the index to add documents to.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetDocumentStatusRequest.Builder>	serializableBuilderClass()
BatchGetDocumentStatusRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

indexId

public final String indexId()

The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.

Returns:

The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.

hasDocumentInfoList

public final boolean hasDocumentInfoList()

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

documentInfoList

public final List<DocumentInfo> documentInfoList()

A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

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

Returns:

A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

toBuilder

public BatchGetDocumentStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetDocumentStatusRequest.Builder,BatchGetDocumentStatusRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static BatchGetDocumentStatusRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo