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

Interface CreateQuerySuggestionsBlockListRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateQuerySuggestionsBlockListRequest.Builder,CreateQuerySuggestionsBlockListRequest>, KendraRequest.Builder, SdkBuilder<CreateQuerySuggestionsBlockListRequest.Builder,CreateQuerySuggestionsBlockListRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateQuerySuggestionsBlockListRequest
public static interface CreateQuerySuggestionsBlockListRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateQuerySuggestionsBlockListRequest.Builder,CreateQuerySuggestionsBlockListRequest>

  • Method Details

    • indexId

      CreateQuerySuggestionsBlockListRequest.Builder indexId(String indexId)

      The identifier of the index you want to create a query suggestions block list for.

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

    • name

      CreateQuerySuggestionsBlockListRequest.Builder name(String name)

      A name for the block list.

      For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

      Parameters:
      name - A name for the block list.

      For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

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

    • description

      CreateQuerySuggestionsBlockListRequest.Builder description(String description)

      A description for the block list.

      For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

      Parameters:
      description - A description for the block list.

      For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

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

    • sourceS3Path

      CreateQuerySuggestionsBlockListRequest.Builder sourceS3Path(S3Path sourceS3Path)

      The 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 - The 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 CreateQuerySuggestionsBlockListRequest.Builder sourceS3Path(Consumer<S3Path.Builder> sourceS3Path)

      The 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:

    • clientToken

      CreateQuerySuggestionsBlockListRequest.Builder clientToken(String clientToken)

      A token that you provide to identify the request to create a query suggestions block list.

      Parameters:
      clientToken - A token that you provide to identify the request to create a query suggestions block list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateQuerySuggestionsBlockListRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateQuerySuggestionsBlockListRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs that identify or categorize the block list. 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 block list. 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

      CreateQuerySuggestionsBlockListRequest.Builder tags(Tag... tags)

      A list of key-value pairs that identify or categorize the block list. 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 block list. 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

      CreateQuerySuggestionsBlockListRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs that identify or categorize the block list. 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<Tag>).

      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:

    • overrideConfiguration

      CreateQuerySuggestionsBlockListRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateQuerySuggestionsBlockListRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.