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

Class UpdateQuerySuggestionsBlockListRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsBlockListRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateQuerySuggestionsBlockListRequest
extends KendraRequest
implements ToCopyableBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateQuerySuggestionsBlockListRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateQuerySuggestionsBlockListRequest.Builder	builder()
String	description()	A new description for the block list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the block list you want to update.
String	indexId()	The identifier of the index for the block list.
String	name()	A new name for the block list.
String	roleArn()	The IAM (Identity and Access Management) role used to access the block list text file in S3.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateQuerySuggestionsBlockListRequest.Builder>	serializableBuilderClass()
S3Path	sourceS3Path()	The S3 path where your block list text file sits in S3.
UpdateQuerySuggestionsBlockListRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

indexId

public final String indexId()

The identifier of the index for the block list.

Returns:

The identifier of the index for the block list.

id

public final String id()

The identifier of the block list you want to update.

Returns:

The identifier of the block list you want to update.

name

public final String name()

A new name for the block list.

Returns:

A new name for the block list.

description

public final String description()

A new description for the block list.

Returns:

A new description for the block list.

sourceS3Path

public final 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.

Returns:

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.

roleArn

public final String roleArn()

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

Returns:

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

toBuilder

public UpdateQuerySuggestionsBlockListRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateQuerySuggestionsBlockListRequest.Builder,UpdateQuerySuggestionsBlockListRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static UpdateQuerySuggestionsBlockListRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateQuerySuggestionsBlockListRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo