Interface DescribeQuerySuggestionsBlockListResponse.Builder

    • Method Detail

      • indexId

        DescribeQuerySuggestionsBlockListResponse.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.
      • description

        DescribeQuerySuggestionsBlockListResponse.Builder description​(String description)

        The description for the block list.

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

        DescribeQuerySuggestionsBlockListResponse.Builder errorMessage​(String errorMessage)

        The error message containing details if there are issues processing the block list.

        Parameters:
        errorMessage - The error message containing details if there are issues processing the block list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdAt

        DescribeQuerySuggestionsBlockListResponse.Builder createdAt​(Instant createdAt)

        The Unix timestamp when a block list for query suggestions was created.

        Parameters:
        createdAt - The Unix timestamp when a block list for query suggestions was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • updatedAt

        DescribeQuerySuggestionsBlockListResponse.Builder updatedAt​(Instant updatedAt)

        The Unix timestamp when a block list for query suggestions was last updated.

        Parameters:
        updatedAt - The Unix timestamp when a block list for query suggestions was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sourceS3Path

        DescribeQuerySuggestionsBlockListResponse.Builder sourceS3Path​(S3Path sourceS3Path)

        Shows the current S3 path to your block list text file in your S3 bucket.

        Each block word or phrase should be on a separate line in a text file.

        For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

        Parameters:
        sourceS3Path - Shows the current S3 path to your block list text file in your S3 bucket.

        Each block word or phrase should be on a separate line in a text file.

        For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

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

        DescribeQuerySuggestionsBlockListResponse.Builder itemCount​(Integer itemCount)

        The current number of valid, non-empty words or phrases in the block list text file.

        Parameters:
        itemCount - The current number of valid, non-empty words or phrases in the block list text file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • fileSizeBytes

        DescribeQuerySuggestionsBlockListResponse.Builder fileSizeBytes​(Long fileSizeBytes)

        The current size of the block list text file in S3.

        Parameters:
        fileSizeBytes - The current size of the block list text file in S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • roleArn

        DescribeQuerySuggestionsBlockListResponse.Builder roleArn​(String roleArn)

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

        The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

        Parameters:
        roleArn - The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

        The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

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