software.amazon.awssdk.services.lexmodelsv2.model

Class KendraConfiguration

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.KendraConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KendraConfiguration.Builder,KendraConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class KendraConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KendraConfiguration.Builder,KendraConfiguration>

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KendraConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static KendraConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kendraIndex() The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
String	queryFilterString() A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
Boolean	queryFilterStringEnabled() Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
List<SdkField<?>>	sdkFields()
static Class<? extends KendraConfiguration.Builder>	serializableBuilderClass()
KendraConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

kendraIndex

public final String kendraIndex()

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

Returns:

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

queryFilterStringEnabled

public final Boolean queryFilterStringEnabled()

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

Returns:

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

queryFilterString

public final String queryFilterString()

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

Returns:

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

toBuilder

public KendraConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KendraConfiguration.Builder,KendraConfiguration>

builder

public static KendraConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo