com.amazonaws.services.kendra.model

Class AttributeSuggestionsDescribeConfig

java.lang.Object

com.amazonaws.services.kendra.model.AttributeSuggestionsDescribeConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeSuggestionsDescribeConfig()

Method Summary

Modifier and Type	Method and Description
AttributeSuggestionsDescribeConfig	clone()
boolean	equals(Object obj)
String	getAttributeSuggestionsMode() The mode is set to either 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) The mode is set to either 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.
AttributeSuggestionsDescribeConfig	withAttributeSuggestionsMode(AttributeSuggestionsMode attributeSuggestionsMode) The mode is set to either ACTIVE or INACTIVE.
AttributeSuggestionsDescribeConfig	withAttributeSuggestionsMode(String attributeSuggestionsMode) The mode is set to either ACTIVE or INACTIVE.
AttributeSuggestionsDescribeConfig	withSuggestableConfigList(Collection<SuggestableConfig> suggestableConfigList) The list of fields/attributes that you want to set as suggestible for query suggestions.
AttributeSuggestionsDescribeConfig	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

AttributeSuggestionsDescribeConfig

public AttributeSuggestionsDescribeConfig()

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 AttributeSuggestionsDescribeConfig 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 AttributeSuggestionsDescribeConfig 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)

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.

Parameters:

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.

See Also:

AttributeSuggestionsMode

getAttributeSuggestionsMode

public String getAttributeSuggestionsMode()

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.

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

withAttributeSuggestionsMode

public AttributeSuggestionsDescribeConfig withAttributeSuggestionsMode(String 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.

Parameters:

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.

Returns:

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

See Also:

AttributeSuggestionsMode

withAttributeSuggestionsMode

public AttributeSuggestionsDescribeConfig withAttributeSuggestionsMode(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.

Parameters:

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.

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