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

Interface CreateFeaturedResultsSetRequest.Builder

    • Method Detail

      • indexId

        CreateFeaturedResultsSetRequest.Builder indexId​(String indexId)

        The identifier of the index that you want to use for featuring results.

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

      • featuredResultsSetName

        CreateFeaturedResultsSetRequest.Builder featuredResultsSetName​(String featuredResultsSetName)

        A name for the set of featured results.

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

      • description

        CreateFeaturedResultsSetRequest.Builder description​(String description)

        A description for the set of featured results.

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

      • clientToken

        CreateFeaturedResultsSetRequest.Builder clientToken​(String clientToken)

        A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

        Parameters:
        clientToken - A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        CreateFeaturedResultsSetRequest.Builder status​(String status)

        The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. 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 - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. 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

        CreateFeaturedResultsSetRequest.Builder status​(FeaturedResultsSetStatus status)

        The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. 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 - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. 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

        CreateFeaturedResultsSetRequest.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

        CreateFeaturedResultsSetRequest.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 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 documents, see FeaturedResultsSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredDocuments

        CreateFeaturedResultsSetRequest.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 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 documents, see FeaturedResultsSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateFeaturedResultsSetRequest.Builder tags​(Collection<Tag> tags)

        A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateFeaturedResultsSetRequest.Builder tags​(Tag... tags)

        A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateFeaturedResultsSetRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

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

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

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