Interface ListKnowledgeBaseDocumentsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BedrockAgentRequest.Builder,Buildable,CopyableBuilder<ListKnowledgeBaseDocumentsRequest.Builder,ListKnowledgeBaseDocumentsRequest>,SdkBuilder<ListKnowledgeBaseDocumentsRequest.Builder,ListKnowledgeBaseDocumentsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListKnowledgeBaseDocumentsRequest
@Mutable @NotThreadSafe public static interface ListKnowledgeBaseDocumentsRequest.Builder extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<ListKnowledgeBaseDocumentsRequest.Builder,ListKnowledgeBaseDocumentsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListKnowledgeBaseDocumentsRequest.BuilderdataSourceId(String dataSourceId)The unique identifier of the data source that contains the documents.ListKnowledgeBaseDocumentsRequest.BuilderknowledgeBaseId(String knowledgeBaseId)The unique identifier of the knowledge base that is connected to the data source.ListKnowledgeBaseDocumentsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return in the response.ListKnowledgeBaseDocumentsRequest.BuildernextToken(String nextToken)If the total number of results is greater than themaxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.ListKnowledgeBaseDocumentsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListKnowledgeBaseDocumentsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.Builder
build
-
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
-
-
-
-
Method Detail
-
knowledgeBaseId
ListKnowledgeBaseDocumentsRequest.Builder knowledgeBaseId(String knowledgeBaseId)
The unique identifier of the knowledge base that is connected to the data source.
- Parameters:
knowledgeBaseId- The unique identifier of the knowledge base that is connected to the data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSourceId
ListKnowledgeBaseDocumentsRequest.Builder dataSourceId(String dataSourceId)
The unique identifier of the data source that contains the documents.
- Parameters:
dataSourceId- The unique identifier of the data source that contains the documents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListKnowledgeBaseDocumentsRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.- Parameters:
maxResults- The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in thenextTokenfield when making another request to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListKnowledgeBaseDocumentsRequest.Builder nextToken(String nextToken)
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.- Parameters:
nextToken- If the total number of results is greater than themaxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListKnowledgeBaseDocumentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListKnowledgeBaseDocumentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-