software.amazon.awssdk.services.kendra.model

Class CreateQuerySuggestionsBlockListRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateQuerySuggestionsBlockListRequest.Builder,CreateQuerySuggestionsBlockListRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateQuerySuggestionsBlockListRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateQuerySuggestionsBlockListRequest.Builder	builder()
String	clientToken() A token that you provide to identify the request to create a query suggestions block list.
String	description() A user-friendly description for the block list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	indexId() The identifier of the index you want to create a query suggestions block list for.
String	name() A user friendly name for the block list.
String	roleArn() The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateQuerySuggestionsBlockListRequest.Builder>	serializableBuilderClass()
S3Path	sourceS3Path() The S3 path to your block list text file in your S3 bucket.
List<Tag>	tags() A tag that you can assign to a block list that categorizes the block list.
CreateQuerySuggestionsBlockListRequest.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 you want to create a query suggestions block list for.

Returns:

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

name

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

Returns:

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.

description

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

Returns:

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

sourceS3Path

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

Returns:

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.

clientToken

public final String clientToken()

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

Returns:

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

roleArn

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

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

toBuilder

public CreateQuerySuggestionsBlockListRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateQuerySuggestionsBlockListRequest.Builder,CreateQuerySuggestionsBlockListRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateQuerySuggestionsBlockListRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateQuerySuggestionsBlockListRequest.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