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

Class AttributeSuggestionsDescribeConfig

java.lang.Object

software.amazon.awssdk.services.kendra.model.AttributeSuggestionsDescribeConfig

All Implemented Interfaces:

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

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

Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use AttributeSuggestionsUpdateConfig and then call UpdateQuerySuggestionsConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttributeSuggestionsDescribeConfig.Builder

Method Summary

Modifier and Type	Method	Description
AttributeSuggestionsMode	attributeSuggestionsMode()	The mode is set to either ACTIVE or INACTIVE.
String	attributeSuggestionsModeAsString()	The mode is set to either ACTIVE or INACTIVE.
static AttributeSuggestionsDescribeConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSuggestableConfigList()	For responses, this returns true if the service returned a value for the SuggestableConfigList property.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributeSuggestionsDescribeConfig.Builder>	serializableBuilderClass()
List<SuggestableConfig>	suggestableConfigList()	The list of fields/attributes that you want to set as suggestible for query suggestions.
AttributeSuggestionsDescribeConfig.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

hasSuggestableConfigList

public final boolean hasSuggestableConfigList()

For responses, this returns true if the service returned a value for the SuggestableConfigList 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.

suggestableConfigList

public final List<SuggestableConfig> suggestableConfigList()

The list of fields/attributes that you want to set as suggestible for query suggestions.

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 hasSuggestableConfigList() method.

Returns:

The list of fields/attributes that you want to set as suggestible for query suggestions.

attributeSuggestionsMode

public final AttributeSuggestionsMode attributeSuggestionsMode()

The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

If the service returns an enum value that is not available in the current SDK version, attributeSuggestionsMode will return AttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeSuggestionsModeAsString().

Returns:

The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

See Also:

AttributeSuggestionsMode

attributeSuggestionsModeAsString

public final String attributeSuggestionsModeAsString()

The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

If the service returns an enum value that is not available in the current SDK version, attributeSuggestionsMode will return AttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeSuggestionsModeAsString().

Returns:

The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

See Also:

AttributeSuggestionsMode

toBuilder

public AttributeSuggestionsDescribeConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeSuggestionsDescribeConfig.Builder,AttributeSuggestionsDescribeConfig>

builder

public static AttributeSuggestionsDescribeConfig.Builder builder()

serializableBuilderClass

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