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

Interface UpdateQuerySuggestionsBlockListRequest.Builder

    • Method Detail

      • indexId

        UpdateQuerySuggestionsBlockListRequest.Builder indexId​(String indexId)

        The identifier of the index for the block list.

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

      • id

        UpdateQuerySuggestionsBlockListRequest.Builder id​(String id)

        The identifier of the block list you want to update.

        Parameters:
        id - The identifier of the block list you want to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateQuerySuggestionsBlockListRequest.Builder description​(String description)

        A new description for the block list.

        Parameters:
        description - A new description for the block list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceS3Path

        UpdateQuerySuggestionsBlockListRequest.Builder sourceS3Path​(S3Path sourceS3Path)

        The S3 path where your block list text file sits in S3.

        If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

        If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

        Parameters:
        sourceS3Path - The S3 path where your block list text file sits in S3.

        If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

        If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceS3Path

        default UpdateQuerySuggestionsBlockListRequest.Builder sourceS3Path​(Consumer<S3Path.Builder> sourceS3Path)

        The S3 path where your block list text file sits in S3.

        If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

        If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceS3Path(S3Path).

        Parameters:
        sourceS3Path - a consumer that will call methods on S3Path.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        sourceS3Path(S3Path)

      • roleArn

        UpdateQuerySuggestionsBlockListRequest.Builder roleArn​(String roleArn)

        The IAM (Identity and Access Management) role used to access the block list text file in S3.

        Parameters:
        roleArn - The IAM (Identity and Access Management) role used to access the block list text file in S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.