software.amazon.awssdk.services.kendra.model

Interface UpdateQuerySuggestionsBlockListRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>, KendraRequest.Builder, SdkBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateQuerySuggestionsBlockListRequest

public static interface UpdateQuerySuggestionsBlockListRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>

Method Summary

Modifier and Type	Method and Description
UpdateQuerySuggestionsBlockListRequest.Builder	description(String description) A new description for the block list.
UpdateQuerySuggestionsBlockListRequest.Builder	id(String id) The identifier of the block list you want to update.
UpdateQuerySuggestionsBlockListRequest.Builder	indexId(String indexId) The identifier of the index for the block list.
UpdateQuerySuggestionsBlockListRequest.Builder	name(String name) A new name for the block list.
UpdateQuerySuggestionsBlockListRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateQuerySuggestionsBlockListRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateQuerySuggestionsBlockListRequest.Builder	roleArn(String roleArn) The IAM (Identity and Access Management) role used to access the block list text file in S3.
default UpdateQuerySuggestionsBlockListRequest.Builder	sourceS3Path(Consumer<S3Path.Builder> sourceS3Path) The S3 path where your block list text file sits in S3.
UpdateQuerySuggestionsBlockListRequest.Builder	sourceS3Path(S3Path sourceS3Path) The S3 path where your block list text file sits in S3.

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

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.

name

UpdateQuerySuggestionsBlockListRequest.Builder name(String name)

A new name for the block list.

Parameters:

name - A new name for the block list.

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.

overrideConfiguration

UpdateQuerySuggestionsBlockListRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder