Interface DescribeQuerySuggestionsBlockListResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>, KendraResponse.Builder, SdkBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeQuerySuggestionsBlockListResponse
@Mutable @NotThreadSafe public static interface DescribeQuerySuggestionsBlockListResponse.Builder extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>

  • Method Details

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

    • id

      DescribeQuerySuggestionsBlockListResponse.Builder id(String id)

      The identifier of the block list.

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

    • name

      DescribeQuerySuggestionsBlockListResponse.Builder name(String name)

      The name of the block list.

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

    • status

      DescribeQuerySuggestionsBlockListResponse.Builder status(String status)

      The current status of the block list. When the value is ACTIVE, the block list is ready for use.

      Parameters:
      status - The current status of the block list. When the value is ACTIVE, the block list is ready for use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeQuerySuggestionsBlockListResponse.Builder status(QuerySuggestionsBlockListStatus status)

      The current status of the block list. When the value is ACTIVE, the block list is ready for use.

      Parameters:
      status - The current status of the block list. When the value is ACTIVE, the block list is ready for use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • sourceS3Path

      default DescribeQuerySuggestionsBlockListResponse.Builder sourceS3Path(Consumer<S3Path.Builder> 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.

      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:

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