com.amazonaws.services.kendra.model

Class AttributeSuggestionsUpdateConfig

java.lang.Object

com.amazonaws.services.kendra.model.AttributeSuggestionsUpdateConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttributeSuggestionsUpdateConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Updates the configuration information for the document fields/attributes that you want to base query suggestions on.

To deactivate using documents fields for query suggestions, set the mode to INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If you set to QUERY, then Amazon Kendra uses the query history to base suggestions on. If you set to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the contents of document fields to base suggestions on.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeSuggestionsUpdateConfig()

Method Summary

Modifier and Type	Method and Description
AttributeSuggestionsUpdateConfig	clone()
boolean	equals(Object obj)
String	getAttributeSuggestionsMode() You can set the mode to ACTIVE or INACTIVE.
List<SuggestableConfig>	getSuggestableConfigList() The list of fields/attributes that you want to set as suggestible for query suggestions.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributeSuggestionsMode(String attributeSuggestionsMode) You can set the mode to ACTIVE or INACTIVE.
void	setSuggestableConfigList(Collection<SuggestableConfig> suggestableConfigList) The list of fields/attributes that you want to set as suggestible for query suggestions.
String	toString() Returns a string representation of this object.
AttributeSuggestionsUpdateConfig	withAttributeSuggestionsMode(AttributeSuggestionsMode attributeSuggestionsMode) You can set the mode to ACTIVE or INACTIVE.
AttributeSuggestionsUpdateConfig	withAttributeSuggestionsMode(String attributeSuggestionsMode) You can set the mode to ACTIVE or INACTIVE.
AttributeSuggestionsUpdateConfig	withSuggestableConfigList(Collection<SuggestableConfig> suggestableConfigList) The list of fields/attributes that you want to set as suggestible for query suggestions.
AttributeSuggestionsUpdateConfig	withSuggestableConfigList(SuggestableConfig... suggestableConfigList) The list of fields/attributes that you want to set as suggestible for query suggestions.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeSuggestionsUpdateConfig

public AttributeSuggestionsUpdateConfig()

Method Detail

getSuggestableConfigList

public List<SuggestableConfig> getSuggestableConfigList()

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

Returns:

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

setSuggestableConfigList

public void setSuggestableConfigList(Collection<SuggestableConfig> suggestableConfigList)

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

Parameters:

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

withSuggestableConfigList

public AttributeSuggestionsUpdateConfig withSuggestableConfigList(SuggestableConfig... suggestableConfigList)

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

NOTE: This method appends the values to the existing list (if any). Use setSuggestableConfigList(java.util.Collection) or withSuggestableConfigList(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSuggestableConfigList

public AttributeSuggestionsUpdateConfig withSuggestableConfigList(Collection<SuggestableConfig> suggestableConfigList)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAttributeSuggestionsMode

public void setAttributeSuggestionsMode(String attributeSuggestionsMode)

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Parameters:

attributeSuggestionsMode - You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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

getAttributeSuggestionsMode

public String getAttributeSuggestionsMode()

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Returns:

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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

withAttributeSuggestionsMode

public AttributeSuggestionsUpdateConfig withAttributeSuggestionsMode(String attributeSuggestionsMode)

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Parameters:

attributeSuggestionsMode - You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AttributeSuggestionsMode

withAttributeSuggestionsMode

public AttributeSuggestionsUpdateConfig withAttributeSuggestionsMode(AttributeSuggestionsMode attributeSuggestionsMode)

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Parameters:

attributeSuggestionsMode - You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AttributeSuggestionsMode

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AttributeSuggestionsUpdateConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.