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 Summary

Modifier and Type	Method and Description
CreateQuerySuggestionsBlockListRequest.Builder	clientToken(String clientToken) A token that you provide to identify the request to create a query suggestions block list.
CreateQuerySuggestionsBlockListRequest.Builder	description(String description) A user-friendly description for the block list.
CreateQuerySuggestionsBlockListRequest.Builder	indexId(String indexId) The identifier of the index you want to create a query suggestions block list for.
CreateQuerySuggestionsBlockListRequest.Builder	name(String name) A user friendly name for the block list.
CreateQuerySuggestionsBlockListRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateQuerySuggestionsBlockListRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateQuerySuggestionsBlockListRequest.Builder	roleArn(String roleArn) The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
default CreateQuerySuggestionsBlockListRequest.Builder	sourceS3Path(Consumer<S3Path.Builder> sourceS3Path) The S3 path to your block list text file in your S3 bucket.
CreateQuerySuggestionsBlockListRequest.Builder	sourceS3Path(S3Path sourceS3Path) The S3 path to your block list text file in your S3 bucket.
CreateQuerySuggestionsBlockListRequest.Builder	tags(Collection<Tag> tags) A tag that you can assign to a block list that categorizes the block list.
CreateQuerySuggestionsBlockListRequest.Builder	tags(Consumer<Tag.Builder>... tags) A tag that you can assign to a block list that categorizes the block list.
CreateQuerySuggestionsBlockListRequest.Builder	tags(Tag... tags) A tag that you can assign to a block list that categorizes the block list.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 user friendly name for the block list.

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

Parameters:

name - A user friendly name for the block list.

For example, the block list named 'offensive-words' 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 user-friendly 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 user-friendly 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:

sourceS3Path(S3Path)

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 IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). 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 your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). 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.

tags

CreateQuerySuggestionsBlockListRequest.Builder tags(Collection<Tag> tags)

A tag that you can assign to a block list that categorizes the block list.

Parameters:

tags - A tag that you can assign to a block list that categorizes the block list.

Returns:

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

tags

CreateQuerySuggestionsBlockListRequest.Builder tags(Tag... tags)

A tag that you can assign to a block list that categorizes the block list.

Parameters:

tags - A tag that you can assign to a block list that categorizes the block list.

Returns:

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

tags

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

A tag that you can assign to a block list that categorizes the block list.

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

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:

#tags(java.util.Collection)

overrideConfiguration

CreateQuerySuggestionsBlockListRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateQuerySuggestionsBlockListRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder