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 Details

    • 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 nextToken field 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 the nextToken field 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 maxResults value provided in the request, enter the token returned in the nextToken field in the response in this 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, enter the token returned in the nextToken field 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListKnowledgeBaseDocumentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.