Package com.algolia.model.querysuggestions

Class QuerySuggestionsConfigurationResponse

java.lang.Object

com.algolia.model.querysuggestions.QuerySuggestionsConfigurationResponse

public class QuerySuggestionsConfigurationResponse
extends Object

QuerySuggestionsConfigurationResponse

Constructor Summary

Constructors

Constructor	Description
QuerySuggestionsConfigurationResponse()

Method Summary

Modifier and Type	Method	Description
QuerySuggestionsConfigurationResponse	addExclude(String excludeItem)
QuerySuggestionsConfigurationResponse	addSourceIndices(SourceIndex sourceIndicesItem)
boolean	equals(Object o)
Boolean	getAllowSpecialCharacters()	Allow suggestions with special characters.
String	getAppId()	Your Algolia application ID.
Boolean	getEnablePersonalization()	Turn on personalized query suggestions.
List<String>	getExclude()	Patterns to exclude from query suggestions.
String	getExternalIndicesAPIKey()	API key used to read from external Algolia indices.
String	getIndexName()	Query Suggestions index name.
Languages	getLanguages()	Get languages
List<SourceIndex>	getSourceIndices()	Algolia indices from which to get the popular searches for query suggestions.
String	getSourceIndicesAPIKey()	API key used to read from your source index.
String	getSuggestionsIndicesAPIKey()	API key used to write and configure your Query Suggestions index.
int	hashCode()
QuerySuggestionsConfigurationResponse	setAllowSpecialCharacters(Boolean allowSpecialCharacters)
QuerySuggestionsConfigurationResponse	setAppId(String appId)
QuerySuggestionsConfigurationResponse	setEnablePersonalization(Boolean enablePersonalization)
QuerySuggestionsConfigurationResponse	setExclude(List<String> exclude)
QuerySuggestionsConfigurationResponse	setExternalIndicesAPIKey(String externalIndicesAPIKey)
QuerySuggestionsConfigurationResponse	setIndexName(String indexName)
QuerySuggestionsConfigurationResponse	setLanguages(Languages languages)
QuerySuggestionsConfigurationResponse	setSourceIndices(List<SourceIndex> sourceIndices)
QuerySuggestionsConfigurationResponse	setSourceIndicesAPIKey(String sourceIndicesAPIKey)
QuerySuggestionsConfigurationResponse	setSuggestionsIndicesAPIKey(String suggestionsIndicesAPIKey)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QuerySuggestionsConfigurationResponse

public QuerySuggestionsConfigurationResponse()

Method Details

setAppId

public QuerySuggestionsConfigurationResponse setAppId(String appId)

getAppId

@Nullable
public String getAppId()

Your Algolia application ID.

Returns:

appId

setSourceIndicesAPIKey

public QuerySuggestionsConfigurationResponse setSourceIndicesAPIKey(String sourceIndicesAPIKey)

getSourceIndicesAPIKey

@Nullable
public String getSourceIndicesAPIKey()

API key used to read from your source index.

Returns:

sourceIndicesAPIKey

setSuggestionsIndicesAPIKey

public QuerySuggestionsConfigurationResponse setSuggestionsIndicesAPIKey(String suggestionsIndicesAPIKey)

getSuggestionsIndicesAPIKey

@Nullable
public String getSuggestionsIndicesAPIKey()

API key used to write and configure your Query Suggestions index.

Returns:

suggestionsIndicesAPIKey

setExternalIndicesAPIKey

public QuerySuggestionsConfigurationResponse setExternalIndicesAPIKey(String externalIndicesAPIKey)

getExternalIndicesAPIKey

@Nullable
public String getExternalIndicesAPIKey()

API key used to read from external Algolia indices.

Returns:

externalIndicesAPIKey

setIndexName

public QuerySuggestionsConfigurationResponse setIndexName(String indexName)

getIndexName

@Nonnull
public String getIndexName()

Query Suggestions index name.

Returns:

indexName

setSourceIndices

public QuerySuggestionsConfigurationResponse setSourceIndices(List<SourceIndex> sourceIndices)

addSourceIndices

public QuerySuggestionsConfigurationResponse addSourceIndices(SourceIndex sourceIndicesItem)

getSourceIndices

@Nonnull
public List<SourceIndex> getSourceIndices()

Algolia indices from which to get the popular searches for query suggestions.

Returns:

sourceIndices

setLanguages

public QuerySuggestionsConfigurationResponse setLanguages(Languages languages)

getLanguages

@Nullable
public Languages getLanguages()

Get languages

Returns:

languages

setExclude

public QuerySuggestionsConfigurationResponse setExclude(List<String> exclude)

addExclude

public QuerySuggestionsConfigurationResponse addExclude(String excludeItem)

getExclude

@Nullable
public List<String> getExclude()

Patterns to exclude from query suggestions.

Returns:

exclude

setEnablePersonalization

public QuerySuggestionsConfigurationResponse setEnablePersonalization(Boolean enablePersonalization)

getEnablePersonalization

@Nullable
public Boolean getEnablePersonalization()

Turn on personalized query suggestions.

Returns:

enablePersonalization

setAllowSpecialCharacters

public QuerySuggestionsConfigurationResponse setAllowSpecialCharacters(Boolean allowSpecialCharacters)

getAllowSpecialCharacters

@Nullable
public Boolean getAllowSpecialCharacters()

Allow suggestions with special characters.

Returns:

allowSpecialCharacters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object