Interface ListKnowledgeBaseDocumentsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentResponse.Builder, Buildable, CopyableBuilder<ListKnowledgeBaseDocumentsResponse.Builder,ListKnowledgeBaseDocumentsResponse>, SdkBuilder<ListKnowledgeBaseDocumentsResponse.Builder,ListKnowledgeBaseDocumentsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListKnowledgeBaseDocumentsResponse

@Mutable
@NotThreadSafe
public static interface ListKnowledgeBaseDocumentsResponse.Builder
extends BedrockAgentResponse.Builder, SdkPojo, CopyableBuilder<ListKnowledgeBaseDocumentsResponse.Builder,ListKnowledgeBaseDocumentsResponse>

Method Summary

Modifier and Type	Method	Description
ListKnowledgeBaseDocumentsResponse.Builder	documentDetails(Collection<KnowledgeBaseDocumentDetail> documentDetails)	A list of objects, each of which contains information about the documents that were retrieved.
ListKnowledgeBaseDocumentsResponse.Builder	documentDetails(Consumer<KnowledgeBaseDocumentDetail.Builder>... documentDetails)	A list of objects, each of which contains information about the documents that were retrieved.
ListKnowledgeBaseDocumentsResponse.Builder	documentDetails(KnowledgeBaseDocumentDetail... documentDetails)	A list of objects, each of which contains information about the documents that were retrieved.
ListKnowledgeBaseDocumentsResponse.Builder	nextToken(String nextToken)	If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

documentDetails

ListKnowledgeBaseDocumentsResponse.Builder documentDetails(Collection<KnowledgeBaseDocumentDetail> documentDetails)

A list of objects, each of which contains information about the documents that were retrieved.

Parameters:

documentDetails - A list of objects, each of which contains information about the documents that were retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentDetails

ListKnowledgeBaseDocumentsResponse.Builder documentDetails(KnowledgeBaseDocumentDetail... documentDetails)

A list of objects, each of which contains information about the documents that were retrieved.

Parameters:

documentDetails - A list of objects, each of which contains information about the documents that were retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentDetails

ListKnowledgeBaseDocumentsResponse.Builder documentDetails(Consumer<KnowledgeBaseDocumentDetail.Builder>... documentDetails)

A list of objects, each of which contains information about the documents that were retrieved.

This is a convenience method that creates an instance of the KnowledgeBaseDocumentDetail.Builder avoiding the need to create one manually via KnowledgeBaseDocumentDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentDetails(List<KnowledgeBaseDocumentDetail>).

Parameters:

documentDetails - a consumer that will call methods on KnowledgeBaseDocumentDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentDetails(java.util.Collection<KnowledgeBaseDocumentDetail>)

nextToken

ListKnowledgeBaseDocumentsResponse.Builder nextToken(String nextToken)

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Parameters:

nextToken - If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

Returns a reference to this object so that method calls can be chained together.