Package software.amazon.awssdk.services.qbusiness.model

Interface ListDocumentsRequest.Builder

    • Method Detail

      • applicationId

        ListDocumentsRequest.Builder applicationId​(String applicationId)

        The identifier of the application id the documents are attached to.

        Parameters:
        applicationId - The identifier of the application id the documents are attached to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSourceIds

        ListDocumentsRequest.Builder dataSourceIds​(Collection<String> dataSourceIds)

        The identifier of the data sources the documents are attached to.

        Parameters:
        dataSourceIds - The identifier of the data sources the documents are attached to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSourceIds

        ListDocumentsRequest.Builder dataSourceIds​(String... dataSourceIds)

        The identifier of the data sources the documents are attached to.

        Parameters:
        dataSourceIds - The identifier of the data sources the documents are attached to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • indexId

        ListDocumentsRequest.Builder indexId​(String indexId)

        The identifier of the index the documents are attached to.

        Parameters:
        indexId - The identifier of the index the documents are attached to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListDocumentsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of documents to return.

        Parameters:
        maxResults - The maximum number of documents to return.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListDocumentsRequest.Builder nextToken​(String nextToken)

        If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

        Parameters:
        nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.