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

Interface UpdateFeaturedResultsSetRequest.Builder

    • Method Detail

      • indexId

        UpdateFeaturedResultsSetRequest.Builder indexId​(String indexId)

        The identifier of the index used for featuring results.

        Parameters:
        indexId - The identifier of the index used for featuring results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredResultsSetId

        UpdateFeaturedResultsSetRequest.Builder featuredResultsSetId​(String featuredResultsSetId)

        The identifier of the set of featured results that you want to update.

        Parameters:
        featuredResultsSetId - The identifier of the set of featured results that you want to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredResultsSetName

        UpdateFeaturedResultsSetRequest.Builder featuredResultsSetName​(String featuredResultsSetName)

        A new name for the set of featured results.

        Parameters:
        featuredResultsSetName - A new name for the set of featured results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateFeaturedResultsSetRequest.Builder description​(String description)

        A new description for the set of featured results.

        Parameters:
        description - A new description for the set of featured results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        UpdateFeaturedResultsSetRequest.Builder status​(String status)

        You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE , featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

        Parameters:
        status - You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FeaturedResultsSetStatus, FeaturedResultsSetStatus

      • status

        UpdateFeaturedResultsSetRequest.Builder status​(FeaturedResultsSetStatus status)

        You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE , featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

        Parameters:
        status - You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FeaturedResultsSetStatus, FeaturedResultsSetStatus

      • queryTexts

        UpdateFeaturedResultsSetRequest.Builder queryTexts​(String... queryTexts)

        A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

        Parameters:
        queryTexts - A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredDocuments

        UpdateFeaturedResultsSetRequest.Builder featuredDocuments​(Collection<FeaturedDocument> featuredDocuments)

        A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.

        Parameters:
        featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredDocuments

        UpdateFeaturedResultsSetRequest.Builder featuredDocuments​(FeaturedDocument... featuredDocuments)

        A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.

        Parameters:
        featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.