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

Interface DescribeFeaturedResultsSetResponse.Builder

    • Method Detail

      • featuredResultsSetId

        DescribeFeaturedResultsSetResponse.Builder featuredResultsSetId​(String featuredResultsSetId)

        The identifier of the set of featured results.

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

      • featuredResultsSetName

        DescribeFeaturedResultsSetResponse.Builder featuredResultsSetName​(String featuredResultsSetName)

        The name for the set of featured results.

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

      • description

        DescribeFeaturedResultsSetResponse.Builder description​(String description)

        The description for the set of featured results.

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

      • status

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

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

        DescribeFeaturedResultsSetResponse.Builder queryTexts​(String... queryTexts)

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

        Parameters:
        queryTexts - The 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.

      • featuredDocumentsWithMetadata

        DescribeFeaturedResultsSetResponse.Builder featuredDocumentsWithMetadata​(Collection<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata)

        The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

        Parameters:
        featuredDocumentsWithMetadata - The list of document IDs for the documents you want to feature with their metadata information. 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.

      • featuredDocumentsWithMetadata

        DescribeFeaturedResultsSetResponse.Builder featuredDocumentsWithMetadata​(FeaturedDocumentWithMetadata... featuredDocumentsWithMetadata)

        The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

        Parameters:
        featuredDocumentsWithMetadata - The list of document IDs for the documents you want to feature with their metadata information. 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.

      • featuredDocumentsMissing

        DescribeFeaturedResultsSetResponse.Builder featuredDocumentsMissing​(Collection<FeaturedDocumentMissing> featuredDocumentsMissing)

        The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

        Parameters:
        featuredDocumentsMissing - The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredDocumentsMissing

        DescribeFeaturedResultsSetResponse.Builder featuredDocumentsMissing​(FeaturedDocumentMissing... featuredDocumentsMissing)

        The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

        Parameters:
        featuredDocumentsMissing - The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedTimestamp

        DescribeFeaturedResultsSetResponse.Builder lastUpdatedTimestamp​(Long lastUpdatedTimestamp)

        The timestamp when the set of featured results was last updated.

        Parameters:
        lastUpdatedTimestamp - The timestamp when the set of featured results was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTimestamp

        DescribeFeaturedResultsSetResponse.Builder creationTimestamp​(Long creationTimestamp)

        The Unix timestamp when the set of the featured results was created.

        Parameters:
        creationTimestamp - The Unix timestamp when the set of the featured results was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.