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

Class SuggestableConfig

java.lang.Object

software.amazon.awssdk.services.kendra.model.SuggestableConfig

All Implemented Interfaces:

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

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

Provides the configuration information for a document field/attribute that you want to base query suggestions on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestableConfig.Builder

Method Summary

Modifier and Type	Method	Description
String	attributeName()	The name of the document field/attribute.
static SuggestableConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestableConfig.Builder>	serializableBuilderClass()
Boolean	suggestable()	TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.
SuggestableConfig.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

attributeName

public final String attributeName()

The name of the document field/attribute.

Returns:

The name of the document field/attribute.

suggestable

public final Boolean suggestable()

TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.

Returns:

TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.

toBuilder

public SuggestableConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestableConfig.Builder,SuggestableConfig>

builder

public static SuggestableConfig.Builder builder()

serializableBuilderClass

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