Package software.amazon.awssdk.services.bedrockagent.model

Class IngestKnowledgeBaseDocumentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.IngestKnowledgeBaseDocumentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<IngestKnowledgeBaseDocumentsRequest.Builder,IngestKnowledgeBaseDocumentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestKnowledgeBaseDocumentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static IngestKnowledgeBaseDocumentsRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	dataSourceId()	The unique identifier of the data source connected to the knowledge base that you're adding documents to.
List<KnowledgeBaseDocument>	documents()	A list of objects, each of which contains information about the documents to add.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocuments()	For responses, this returns true if the service returned a value for the Documents property.
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the knowledge base to ingest the documents into.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IngestKnowledgeBaseDocumentsRequest.Builder>	serializableBuilderClass()
IngestKnowledgeBaseDocumentsRequest.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

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge base to ingest the documents into.

Returns:

The unique identifier of the knowledge base to ingest the documents into.

dataSourceId

public final String dataSourceId()

The unique identifier of the data source connected to the knowledge base that you're adding documents to.

Returns:

The unique identifier of the data source connected to the knowledge base that you're adding documents to.

clientToken

public final String clientToken()

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

hasDocuments

public final boolean hasDocuments()

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

documents

public final List<KnowledgeBaseDocument> documents()

A list of objects, each of which contains information about the documents to add.

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

Returns:

A list of objects, each of which contains information about the documents to add.

toBuilder

public IngestKnowledgeBaseDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IngestKnowledgeBaseDocumentsRequest.Builder,IngestKnowledgeBaseDocumentsRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static IngestKnowledgeBaseDocumentsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo