Package software.amazon.awssdk.services.kendra.model

Interface ExpandedResultItem.Builder

    • Method Detail

      • id

        ExpandedResultItem.Builder id​(String id)

        The identifier for the expanded result.

        Parameters:
        id - The identifier for the expanded result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentId

        ExpandedResultItem.Builder documentId​(String documentId)

        The idenitifier of the document.

        Parameters:
        documentId - The idenitifier of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentTitle

        ExpandedResultItem.Builder documentTitle​(TextWithHighlights documentTitle)
        Sets the value of the DocumentTitle property for this object.
        Parameters:
        documentTitle - The new value for the DocumentTitle property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentExcerpt

        ExpandedResultItem.Builder documentExcerpt​(TextWithHighlights documentExcerpt)
        Sets the value of the DocumentExcerpt property for this object.
        Parameters:
        documentExcerpt - The new value for the DocumentExcerpt property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentURI

        ExpandedResultItem.Builder documentURI​(String documentURI)

        The URI of the original location of the document.

        Parameters:
        documentURI - The URI of the original location of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        ExpandedResultItem.Builder documentAttributes​(Collection<DocumentAttribute> documentAttributes)

        An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

        Parameters:
        documentAttributes - An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        ExpandedResultItem.Builder documentAttributes​(DocumentAttribute... documentAttributes)

        An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

        Parameters:
        documentAttributes - An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        ExpandedResultItem.Builder documentAttributes​(Consumer<DocumentAttribute.Builder>... documentAttributes)

        An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #documentAttributes(List).

        Parameters:
        documentAttributes - a consumer that will call methods on DocumentAttribute.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #documentAttributes(java.util.Collection)