com.algolia.model.search.IndexSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch Show documentation
Show all versions of algoliasearch Show documentation
Java client for Algolia Search API
The newest version!
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost
// - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
package com.algolia.model.search;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/** Index settings. */
public class IndexSettings {
@JsonProperty("attributesForFaceting")
private List attributesForFaceting;
@JsonProperty("replicas")
private List replicas;
@JsonProperty("paginationLimitedTo")
private Integer paginationLimitedTo;
@JsonProperty("unretrievableAttributes")
private List unretrievableAttributes;
@JsonProperty("disableTypoToleranceOnWords")
private List disableTypoToleranceOnWords;
@JsonProperty("attributesToTransliterate")
private List attributesToTransliterate;
@JsonProperty("camelCaseAttributes")
private List camelCaseAttributes;
@JsonProperty("decompoundedAttributes")
private Object decompoundedAttributes;
@JsonProperty("indexLanguages")
private List indexLanguages;
@JsonProperty("disablePrefixOnAttributes")
private List disablePrefixOnAttributes;
@JsonProperty("allowCompressionOfIntegerArray")
private Boolean allowCompressionOfIntegerArray;
@JsonProperty("numericAttributesForFiltering")
private List numericAttributesForFiltering;
@JsonProperty("separatorsToIndex")
private String separatorsToIndex;
@JsonProperty("searchableAttributes")
private List searchableAttributes;
@JsonProperty("userData")
private Object userData;
@JsonProperty("customNormalization")
private Map> customNormalization;
@JsonProperty("attributeForDistinct")
private String attributeForDistinct;
@JsonProperty("maxFacetHits")
private Integer maxFacetHits;
@JsonProperty("attributesToRetrieve")
private List attributesToRetrieve;
@JsonProperty("ranking")
private List ranking;
@JsonProperty("customRanking")
private List customRanking;
@JsonProperty("relevancyStrictness")
private Integer relevancyStrictness;
@JsonProperty("attributesToHighlight")
private List attributesToHighlight;
@JsonProperty("attributesToSnippet")
private List attributesToSnippet;
@JsonProperty("highlightPreTag")
private String highlightPreTag;
@JsonProperty("highlightPostTag")
private String highlightPostTag;
@JsonProperty("snippetEllipsisText")
private String snippetEllipsisText;
@JsonProperty("restrictHighlightAndSnippetArrays")
private Boolean restrictHighlightAndSnippetArrays;
@JsonProperty("hitsPerPage")
private Integer hitsPerPage;
@JsonProperty("minWordSizefor1Typo")
private Integer minWordSizefor1Typo;
@JsonProperty("minWordSizefor2Typos")
private Integer minWordSizefor2Typos;
@JsonProperty("typoTolerance")
private TypoTolerance typoTolerance;
@JsonProperty("allowTyposOnNumericTokens")
private Boolean allowTyposOnNumericTokens;
@JsonProperty("disableTypoToleranceOnAttributes")
private List disableTypoToleranceOnAttributes;
@JsonProperty("ignorePlurals")
private IgnorePlurals ignorePlurals;
@JsonProperty("removeStopWords")
private RemoveStopWords removeStopWords;
@JsonProperty("keepDiacriticsOnCharacters")
private String keepDiacriticsOnCharacters;
@JsonProperty("queryLanguages")
private List queryLanguages;
@JsonProperty("decompoundQuery")
private Boolean decompoundQuery;
@JsonProperty("enableRules")
private Boolean enableRules;
@JsonProperty("enablePersonalization")
private Boolean enablePersonalization;
@JsonProperty("queryType")
private QueryType queryType;
@JsonProperty("removeWordsIfNoResults")
private RemoveWordsIfNoResults removeWordsIfNoResults;
@JsonProperty("mode")
private Mode mode;
@JsonProperty("semanticSearch")
private SemanticSearch semanticSearch;
@JsonProperty("advancedSyntax")
private Boolean advancedSyntax;
@JsonProperty("optionalWords")
private OptionalWords optionalWords;
@JsonProperty("disableExactOnAttributes")
private List disableExactOnAttributes;
@JsonProperty("exactOnSingleWordQuery")
private ExactOnSingleWordQuery exactOnSingleWordQuery;
@JsonProperty("alternativesAsExact")
private List alternativesAsExact;
@JsonProperty("advancedSyntaxFeatures")
private List advancedSyntaxFeatures;
@JsonProperty("distinct")
private Distinct distinct;
@JsonProperty("replaceSynonymsInHighlight")
private Boolean replaceSynonymsInHighlight;
@JsonProperty("minProximity")
private Integer minProximity;
@JsonProperty("responseFields")
private List responseFields;
@JsonProperty("maxValuesPerFacet")
private Integer maxValuesPerFacet;
@JsonProperty("sortFacetValuesBy")
private String sortFacetValuesBy;
@JsonProperty("attributeCriteriaComputedByMinProximity")
private Boolean attributeCriteriaComputedByMinProximity;
@JsonProperty("renderingContent")
private RenderingContent renderingContent;
@JsonProperty("enableReRanking")
private Boolean enableReRanking;
@JsonProperty("reRankingApplyFilter")
private ReRankingApplyFilter reRankingApplyFilter;
public IndexSettings setAttributesForFaceting(List attributesForFaceting) {
this.attributesForFaceting = attributesForFaceting;
return this;
}
public IndexSettings addAttributesForFaceting(String attributesForFacetingItem) {
if (this.attributesForFaceting == null) {
this.attributesForFaceting = new ArrayList<>();
}
this.attributesForFaceting.add(attributesForFacetingItem);
return this;
}
/**
* Attributes used for
* [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
* Facets are attributes that let you categorize search results. They can be used for filtering
* search results. By default, no attribute is used for faceting. Attribute names are
* case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as
* a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching
* for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_
* deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier
* to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
*/
@javax.annotation.Nullable
public List getAttributesForFaceting() {
return attributesForFaceting;
}
public IndexSettings setReplicas(List replicas) {
this.replicas = replicas;
return this;
}
public IndexSettings addReplicas(String replicasItem) {
if (this.replicas == null) {
this.replicas = new ArrayList<>();
}
this.replicas.add(replicasItem);
return this;
}
/**
* Creates [replica
* indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
* Replicas are copies of a primary index with the same records but different settings, synonyms,
* or rules. If you want to offer a different ranking or sorting of your search results, you'll
* use replica indices. All index operations on a primary index are automatically forwarded to its
* replicas. To add a replica index, you must provide the complete set of replicas to this
* parameter. If you omit a replica from this list, the replica turns into a regular, standalone
* index that will no longer be synced with the primary index. **Modifier** -
* `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of
* records and are optimized for [Relevant
* sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
*/
@javax.annotation.Nullable
public List getReplicas() {
return replicas;
}
public IndexSettings setPaginationLimitedTo(Integer paginationLimitedTo) {
this.paginationLimitedTo = paginationLimitedTo;
return this;
}
/**
* Maximum number of search results that can be obtained through pagination. Higher pagination
* limits might slow down your search. For pagination limits above 1,000, the sorting of results
* beyond the 1,000th hit can't be guaranteed. maximum: 20000
*/
@javax.annotation.Nullable
public Integer getPaginationLimitedTo() {
return paginationLimitedTo;
}
public IndexSettings setUnretrievableAttributes(List unretrievableAttributes) {
this.unretrievableAttributes = unretrievableAttributes;
return this;
}
public IndexSettings addUnretrievableAttributes(String unretrievableAttributesItem) {
if (this.unretrievableAttributes == null) {
this.unretrievableAttributes = new ArrayList<>();
}
this.unretrievableAttributes.add(unretrievableAttributesItem);
return this;
}
/**
* Attributes that can't be retrieved at query time. This can be useful if you want to use an
* attribute for ranking or to [restrict
* access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/),
* but don't want to include it in the search results. Attribute names are case-sensitive.
*/
@javax.annotation.Nullable
public List getUnretrievableAttributes() {
return unretrievableAttributes;
}
public IndexSettings setDisableTypoToleranceOnWords(List disableTypoToleranceOnWords) {
this.disableTypoToleranceOnWords = disableTypoToleranceOnWords;
return this;
}
public IndexSettings addDisableTypoToleranceOnWords(String disableTypoToleranceOnWordsItem) {
if (this.disableTypoToleranceOnWords == null) {
this.disableTypoToleranceOnWords = new ArrayList<>();
}
this.disableTypoToleranceOnWords.add(disableTypoToleranceOnWordsItem);
return this;
}
/**
* Creates a list of [words which require exact
* matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words).
* This also turns off [word splitting and
* concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/)
* for the specified words.
*/
@javax.annotation.Nullable
public List getDisableTypoToleranceOnWords() {
return disableTypoToleranceOnWords;
}
public IndexSettings setAttributesToTransliterate(List attributesToTransliterate) {
this.attributesToTransliterate = attributesToTransliterate;
return this;
}
public IndexSettings addAttributesToTransliterate(String attributesToTransliterateItem) {
if (this.attributesToTransliterate == null) {
this.attributesToTransliterate = new ArrayList<>();
}
this.attributesToTransliterate.add(attributesToTransliterateItem);
return this;
}
/**
* Attributes, for which you want to support [Japanese
* transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).
* Transliteration supports searching in any of the Japanese writing systems. To support
* transliteration, you must set the indexing language to Japanese. Attribute names are
* case-sensitive.
*/
@javax.annotation.Nullable
public List getAttributesToTransliterate() {
return attributesToTransliterate;
}
public IndexSettings setCamelCaseAttributes(List camelCaseAttributes) {
this.camelCaseAttributes = camelCaseAttributes;
return this;
}
public IndexSettings addCamelCaseAttributes(String camelCaseAttributesItem) {
if (this.camelCaseAttributes == null) {
this.camelCaseAttributes = new ArrayList<>();
}
this.camelCaseAttributes.add(camelCaseAttributesItem);
return this;
}
/**
* Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
* Attribute names are case-sensitive.
*/
@javax.annotation.Nullable
public List getCamelCaseAttributes() {
return camelCaseAttributes;
}
public IndexSettings setDecompoundedAttributes(Object decompoundedAttributes) {
this.decompoundedAttributes = decompoundedAttributes;
return this;
}
/**
* Searchable attributes to which Algolia should apply [word
* segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/)
* (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two
* or more individual words, and are particularly prevalent in Germanic languages—for example,
* \"firefighter\". With decompounding, the individual components are indexed separately. You can
* specify different lists for different languages. Decompounding is supported for these
* languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and
* Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode
* characters](https://www.charactercodes.net/category/non-spacing_mark). For example,
* `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
*/
@javax.annotation.Nullable
public Object getDecompoundedAttributes() {
return decompoundedAttributes;
}
public IndexSettings setIndexLanguages(List indexLanguages) {
this.indexLanguages = indexLanguages;
return this;
}
public IndexSettings addIndexLanguages(SupportedLanguage indexLanguagesItem) {
if (this.indexLanguages == null) {
this.indexLanguages = new ArrayList<>();
}
this.indexLanguages.add(indexLanguagesItem);
return this;
}
/**
* Languages for language-specific processing steps, such as word detection and dictionary
* settings. **You should always specify an indexing language.** If you don't specify an indexing
* language, the search engine uses all [supported
* languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
* or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This
* can lead to unexpected search results. For more information, see [Language-specific
* configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
*/
@javax.annotation.Nullable
public List getIndexLanguages() {
return indexLanguages;
}
public IndexSettings setDisablePrefixOnAttributes(List disablePrefixOnAttributes) {
this.disablePrefixOnAttributes = disablePrefixOnAttributes;
return this;
}
public IndexSettings addDisablePrefixOnAttributes(String disablePrefixOnAttributesItem) {
if (this.disablePrefixOnAttributes == null) {
this.disablePrefixOnAttributes = new ArrayList<>();
}
this.disablePrefixOnAttributes.add(disablePrefixOnAttributesItem);
return this;
}
/**
* Searchable attributes for which you want to turn off [prefix
* matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
* Attribute names are case-sensitive.
*/
@javax.annotation.Nullable
public List getDisablePrefixOnAttributes() {
return disablePrefixOnAttributes;
}
public IndexSettings setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray) {
this.allowCompressionOfIntegerArray = allowCompressionOfIntegerArray;
return this;
}
/**
* Whether arrays with exclusively non-negative integers should be compressed for better
* performance. If true, the compressed arrays may be reordered.
*/
@javax.annotation.Nullable
public Boolean getAllowCompressionOfIntegerArray() {
return allowCompressionOfIntegerArray;
}
public IndexSettings setNumericAttributesForFiltering(List numericAttributesForFiltering) {
this.numericAttributesForFiltering = numericAttributesForFiltering;
return this;
}
public IndexSettings addNumericAttributesForFiltering(String numericAttributesForFilteringItem) {
if (this.numericAttributesForFiltering == null) {
this.numericAttributesForFiltering = new ArrayList<>();
}
this.numericAttributesForFiltering.add(numericAttributesForFilteringItem);
return this;
}
/**
* Numeric attributes that can be used as [numerical
* filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
* Attribute names are case-sensitive. By default, all numeric attributes are available as
* numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off
* filtering for all numeric attributes, specify an attribute that doesn't exist in your index,
* such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only
* filtering based on equality comparisons `=` and `!=`.
*/
@javax.annotation.Nullable
public List getNumericAttributesForFiltering() {
return numericAttributesForFiltering;
}
public IndexSettings setSeparatorsToIndex(String separatorsToIndex) {
this.separatorsToIndex = separatorsToIndex;
return this;
}
/**
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores
* [non-alphanumeric
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define
* them with `separatorsToIndex`. Separators are all non-letter characters except spaces and
* currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator
* characters as separate words. For example, in a search for \"Disney+\", Algolia considers
* \"Disney\" and \"+\" as two separate words.
*/
@javax.annotation.Nullable
public String getSeparatorsToIndex() {
return separatorsToIndex;
}
public IndexSettings setSearchableAttributes(List searchableAttributes) {
this.searchableAttributes = searchableAttributes;
return this;
}
public IndexSettings addSearchableAttributes(String searchableAttributesItem) {
if (this.searchableAttributes == null) {
this.searchableAttributes = new ArrayList<>();
}
this.searchableAttributes.add(searchableAttributesItem);
return this;
}
/**
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes
* are searchable and the
* [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)
* ranking criterion is turned off. With a non-empty list, Algolia only returns results with
* matches in the selected attributes. In addition, the Attribute ranking criterion is turned on:
* matches in attributes that are higher in the list of `searchableAttributes` rank first. To make
* matches in two attributes rank equally, include them in a comma-separated string, such as
* `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more
* information, see [Searchable
* attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).
* **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute.
* Without a modifier, matches at the beginning of an attribute rank higher than matches at the
* end.
*/
@javax.annotation.Nullable
public List getSearchableAttributes() {
return searchableAttributes;
}
public IndexSettings setUserData(Object userData) {
this.userData = userData;
return this;
}
/** An object with custom data. You can store up to 32kB as custom data. */
@javax.annotation.Nullable
public Object getUserData() {
return userData;
}
public IndexSettings setCustomNormalization(Map> customNormalization) {
this.customNormalization = customNormalization;
return this;
}
public IndexSettings putCustomNormalization(String key, Map customNormalizationItem) {
if (this.customNormalization == null) {
this.customNormalization = new HashMap<>();
}
this.customNormalization.put(key, customNormalizationItem);
return this;
}
/**
* Characters and their normalized replacements. This overrides Algolia's default
* [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
*/
@javax.annotation.Nullable
public Map> getCustomNormalization() {
return customNormalization;
}
public IndexSettings setAttributeForDistinct(String attributeForDistinct) {
this.attributeForDistinct = attributeForDistinct;
return this;
}
/**
* Attribute that should be used to establish groups of results. Attribute names are
* case-sensitive. All records with the same value for this attribute are considered a group. You
* can combine `attributeForDistinct` with the `distinct` search parameter to control how many
* items per group are included in the search results. If you want to use the same attribute also
* for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This
* applies faceting _after_ deduplication, which will result in accurate facet counts.
*/
@javax.annotation.Nullable
public String getAttributeForDistinct() {
return attributeForDistinct;
}
public IndexSettings setMaxFacetHits(Integer maxFacetHits) {
this.maxFacetHits = maxFacetHits;
return this;
}
/**
* Maximum number of facet values to return when [searching for facet
* values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
* maximum: 100
*/
@javax.annotation.Nullable
public Integer getMaxFacetHits() {
return maxFacetHits;
}
public IndexSettings setAttributesToRetrieve(List attributesToRetrieve) {
this.attributesToRetrieve = attributesToRetrieve;
return this;
}
public IndexSettings addAttributesToRetrieve(String attributesToRetrieveItem) {
if (this.attributesToRetrieve == null) {
this.attributesToRetrieve = new ArrayList<>();
}
this.attributesToRetrieve.add(attributesToRetrieveItem);
return this;
}
/**
* Attributes to include in the API response. To reduce the size of your response, you can
* retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all
* attributes, except attributes included in the `customRanking` and `unretrievableAttributes`
* settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash
* and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always
* included.
*/
@javax.annotation.Nullable
public List getAttributesToRetrieve() {
return attributesToRetrieve;
}
public IndexSettings setRanking(List ranking) {
this.ranking = ranking;
return this;
}
public IndexSettings addRanking(String rankingItem) {
if (this.ranking == null) {
this.ranking = new ArrayList<>();
}
this.ranking.add(rankingItem);
return this;
}
/**
* Determines the order in which Algolia returns your results. By default, each entry corresponds
* to a [ranking
* criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
* The tie-breaking algorithm sequentially applies each criterion in the order they're specified.
* If you configure a replica index for [sorting by an
* attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/),
* you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`.
* Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort
* the index by the values of an attribute, in descending order. Before you modify the default
* setting, you should test your changes in the dashboard, and by [A/B
* testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
*/
@javax.annotation.Nullable
public List getRanking() {
return ranking;
}
public IndexSettings setCustomRanking(List customRanking) {
this.customRanking = customRanking;
return this;
}
public IndexSettings addCustomRanking(String customRankingItem) {
if (this.customRanking == null) {
this.customRanking = new ArrayList<>();
}
this.customRanking.add(customRankingItem);
return this;
}
/**
* Attributes to use as [custom
* ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).
* Attribute names are case-sensitive. The custom ranking attributes decide which items are shown
* first if the other ranking criteria are equal. Records with missing values for your selected
* custom ranking attributes are always sorted last. Boolean attributes are sorted based on their
* alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an
* attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an
* attribute, in descending order. If you use two or more custom ranking attributes, [reduce the
* precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/)
* of your first attributes, or the other attributes will never be applied.
*/
@javax.annotation.Nullable
public List getCustomRanking() {
return customRanking;
}
public IndexSettings setRelevancyStrictness(Integer relevancyStrictness) {
this.relevancyStrictness = relevancyStrictness;
return this;
}
/**
* Relevancy threshold below which less relevant results aren't included in the results. You can
* only set `relevancyStrictness` on [virtual replica
* indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
* Use this setting to strike a balance between the relevance and number of returned results.
*/
@javax.annotation.Nullable
public Integer getRelevancyStrictness() {
return relevancyStrictness;
}
public IndexSettings setAttributesToHighlight(List attributesToHighlight) {
this.attributesToHighlight = attributesToHighlight;
return this;
}
public IndexSettings addAttributesToHighlight(String attributesToHighlightItem) {
if (this.attributesToHighlight == null) {
this.attributesToHighlight = new ArrayList<>();
}
this.attributesToHighlight.add(attributesToHighlightItem);
return this;
}
/**
* Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to
* highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names
* are case-sensitive. With highlighting, strings that match the search query are surrounded by
* HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually
* highlight matching parts of a search query in your UI. For more information, see [Highlighting
* and
* snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
*/
@javax.annotation.Nullable
public List getAttributesToHighlight() {
return attributesToHighlight;
}
public IndexSettings setAttributesToSnippet(List attributesToSnippet) {
this.attributesToSnippet = attributesToSnippet;
return this;
}
public IndexSettings addAttributesToSnippet(String attributesToSnippetItem) {
if (this.attributesToSnippet == null) {
this.attributesToSnippet = new ArrayList<>();
}
this.attributesToSnippet.add(attributesToSnippetItem);
return this;
}
/**
* Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide
* additional context to matched words. If you enable snippets, they include 10 words, including
* the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can
* adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is
* the number of words to be extracted.
*/
@javax.annotation.Nullable
public List getAttributesToSnippet() {
return attributesToSnippet;
}
public IndexSettings setHighlightPreTag(String highlightPreTag) {
this.highlightPreTag = highlightPreTag;
return this;
}
/** HTML tag to insert before the highlighted parts in all highlighted results and snippets. */
@javax.annotation.Nullable
public String getHighlightPreTag() {
return highlightPreTag;
}
public IndexSettings setHighlightPostTag(String highlightPostTag) {
this.highlightPostTag = highlightPostTag;
return this;
}
/** HTML tag to insert after the highlighted parts in all highlighted results and snippets. */
@javax.annotation.Nullable
public String getHighlightPostTag() {
return highlightPostTag;
}
public IndexSettings setSnippetEllipsisText(String snippetEllipsisText) {
this.snippetEllipsisText = snippetEllipsisText;
return this;
}
/** String used as an ellipsis indicator when a snippet is truncated. */
@javax.annotation.Nullable
public String getSnippetEllipsisText() {
return snippetEllipsisText;
}
public IndexSettings setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays) {
this.restrictHighlightAndSnippetArrays = restrictHighlightAndSnippetArrays;
return this;
}
/**
* Whether to restrict highlighting and snippeting to items that at least partially matched the
* search query. By default, all items are highlighted and snippeted.
*/
@javax.annotation.Nullable
public Boolean getRestrictHighlightAndSnippetArrays() {
return restrictHighlightAndSnippetArrays;
}
public IndexSettings setHitsPerPage(Integer hitsPerPage) {
this.hitsPerPage = hitsPerPage;
return this;
}
/** Number of hits per page. minimum: 1 maximum: 1000 */
@javax.annotation.Nullable
public Integer getHitsPerPage() {
return hitsPerPage;
}
public IndexSettings setMinWordSizefor1Typo(Integer minWordSizefor1Typo) {
this.minWordSizefor1Typo = minWordSizefor1Typo;
return this;
}
/**
* Minimum number of characters a word in the search query must contain to accept matches with
* [one
* typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
*/
@javax.annotation.Nullable
public Integer getMinWordSizefor1Typo() {
return minWordSizefor1Typo;
}
public IndexSettings setMinWordSizefor2Typos(Integer minWordSizefor2Typos) {
this.minWordSizefor2Typos = minWordSizefor2Typos;
return this;
}
/**
* Minimum number of characters a word in the search query must contain to accept matches with
* [two
* typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
*/
@javax.annotation.Nullable
public Integer getMinWordSizefor2Typos() {
return minWordSizefor2Typos;
}
public IndexSettings setTypoTolerance(TypoTolerance typoTolerance) {
this.typoTolerance = typoTolerance;
return this;
}
/** Get typoTolerance */
@javax.annotation.Nullable
public TypoTolerance getTypoTolerance() {
return typoTolerance;
}
public IndexSettings setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens) {
this.allowTyposOnNumericTokens = allowTyposOnNumericTokens;
return this;
}
/**
* Whether to allow typos on numbers in the search query. Turn off this setting to reduce the
* number of irrelevant matches when searching in large sets of similar numbers.
*/
@javax.annotation.Nullable
public Boolean getAllowTyposOnNumericTokens() {
return allowTyposOnNumericTokens;
}
public IndexSettings setDisableTypoToleranceOnAttributes(List disableTypoToleranceOnAttributes) {
this.disableTypoToleranceOnAttributes = disableTypoToleranceOnAttributes;
return this;
}
public IndexSettings addDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributesItem) {
if (this.disableTypoToleranceOnAttributes == null) {
this.disableTypoToleranceOnAttributes = new ArrayList<>();
}
this.disableTypoToleranceOnAttributes.add(disableTypoToleranceOnAttributesItem);
return this;
}
/**
* Attributes for which you want to turn off [typo
* tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
* Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in
* hyphenated
* attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/).
* - Reducing the number of matches when you have too many. This can happen with attributes that
* are long blocks of text, such as product descriptions. Consider alternatives such as
* `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual
* spellings that might look like typos.
*/
@javax.annotation.Nullable
public List getDisableTypoToleranceOnAttributes() {
return disableTypoToleranceOnAttributes;
}
public IndexSettings setIgnorePlurals(IgnorePlurals ignorePlurals) {
this.ignorePlurals = ignorePlurals;
return this;
}
/** Get ignorePlurals */
@javax.annotation.Nullable
public IgnorePlurals getIgnorePlurals() {
return ignorePlurals;
}
public IndexSettings setRemoveStopWords(RemoveStopWords removeStopWords) {
this.removeStopWords = removeStopWords;
return this;
}
/** Get removeStopWords */
@javax.annotation.Nullable
public RemoveStopWords getRemoveStopWords() {
return removeStopWords;
}
public IndexSettings setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters) {
this.keepDiacriticsOnCharacters = keepDiacriticsOnCharacters;
return this;
}
/**
* Characters for which diacritics should be preserved. By default, Algolia removes diacritics
* from letters. For example, `é` becomes `e`. If this causes issues in your search, you can
* specify characters that should keep their diacritics.
*/
@javax.annotation.Nullable
public String getKeepDiacriticsOnCharacters() {
return keepDiacriticsOnCharacters;
}
public IndexSettings setQueryLanguages(List queryLanguages) {
this.queryLanguages = queryLanguages;
return this;
}
public IndexSettings addQueryLanguages(SupportedLanguage queryLanguagesItem) {
if (this.queryLanguages == null) {
this.queryLanguages = new ArrayList<>();
}
this.queryLanguages.add(queryLanguagesItem);
return this;
}
/**
* Languages for language-specific query processing steps such as plurals, stop-word removal, and
* word-detection dictionaries. This setting sets a default list of languages used by the
* `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word
* detection in the logogram-based
* [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk)
* languages. To support this, you must place the CJK language **first**. **You should always
* specify a query language.** If you don't specify an indexing language, the search engine uses
* all [supported
* languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
* or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This
* can lead to unexpected search results. For more information, see [Language-specific
* configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
*/
@javax.annotation.Nullable
public List getQueryLanguages() {
return queryLanguages;
}
public IndexSettings setDecompoundQuery(Boolean decompoundQuery) {
this.decompoundQuery = decompoundQuery;
return this;
}
/**
* Whether to split compound words in the query into their building blocks. For more information,
* see [Word
* segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words).
* Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and
* Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode
* characters](https://www.charactercodes.net/category/non-spacing_mark). For example,
* `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
*/
@javax.annotation.Nullable
public Boolean getDecompoundQuery() {
return decompoundQuery;
}
public IndexSettings setEnableRules(Boolean enableRules) {
this.enableRules = enableRules;
return this;
}
/** Whether to enable rules. */
@javax.annotation.Nullable
public Boolean getEnableRules() {
return enableRules;
}
public IndexSettings setEnablePersonalization(Boolean enablePersonalization) {
this.enablePersonalization = enablePersonalization;
return this;
}
/** Whether to enable Personalization. */
@javax.annotation.Nullable
public Boolean getEnablePersonalization() {
return enablePersonalization;
}
public IndexSettings setQueryType(QueryType queryType) {
this.queryType = queryType;
return this;
}
/** Get queryType */
@javax.annotation.Nullable
public QueryType getQueryType() {
return queryType;
}
public IndexSettings setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults) {
this.removeWordsIfNoResults = removeWordsIfNoResults;
return this;
}
/** Get removeWordsIfNoResults */
@javax.annotation.Nullable
public RemoveWordsIfNoResults getRemoveWordsIfNoResults() {
return removeWordsIfNoResults;
}
public IndexSettings setMode(Mode mode) {
this.mode = mode;
return this;
}
/** Get mode */
@javax.annotation.Nullable
public Mode getMode() {
return mode;
}
public IndexSettings setSemanticSearch(SemanticSearch semanticSearch) {
this.semanticSearch = semanticSearch;
return this;
}
/** Get semanticSearch */
@javax.annotation.Nullable
public SemanticSearch getSemanticSearch() {
return semanticSearch;
}
public IndexSettings setAdvancedSyntax(Boolean advancedSyntax) {
this.advancedSyntax = advancedSyntax;
return this;
}
/**
* Whether to support phrase matching and excluding words from search queries. Use the
* `advancedSyntaxFeatures` parameter to control which feature is supported.
*/
@javax.annotation.Nullable
public Boolean getAdvancedSyntax() {
return advancedSyntax;
}
public IndexSettings setOptionalWords(OptionalWords optionalWords) {
this.optionalWords = optionalWords;
return this;
}
/** Get optionalWords */
@javax.annotation.Nullable
public OptionalWords getOptionalWords() {
return optionalWords;
}
public IndexSettings setDisableExactOnAttributes(List disableExactOnAttributes) {
this.disableExactOnAttributes = disableExactOnAttributes;
return this;
}
public IndexSettings addDisableExactOnAttributes(String disableExactOnAttributesItem) {
if (this.disableExactOnAttributes == null) {
this.disableExactOnAttributes = new ArrayList<>();
}
this.disableExactOnAttributes.add(disableExactOnAttributesItem);
return this;
}
/**
* Searchable attributes for which you want to [turn off the Exact ranking
* criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
* Attribute names are case-sensitive. This can be useful for attributes with long values, where
* the likelihood of an exact match is high, such as product descriptions. Turning off the Exact
* ranking criterion for these attributes favors exact matching on other attributes. This reduces
* the impact of individual attributes with a lot of content on ranking.
*/
@javax.annotation.Nullable
public List getDisableExactOnAttributes() {
return disableExactOnAttributes;
}
public IndexSettings setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery) {
this.exactOnSingleWordQuery = exactOnSingleWordQuery;
return this;
}
/** Get exactOnSingleWordQuery */
@javax.annotation.Nullable
public ExactOnSingleWordQuery getExactOnSingleWordQuery() {
return exactOnSingleWordQuery;
}
public IndexSettings setAlternativesAsExact(List alternativesAsExact) {
this.alternativesAsExact = alternativesAsExact;
return this;
}
public IndexSettings addAlternativesAsExact(AlternativesAsExact alternativesAsExactItem) {
if (this.alternativesAsExact == null) {
this.alternativesAsExact = new ArrayList<>();
}
this.alternativesAsExact.add(alternativesAsExactItem);
return this;
}
/**
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
* treats singular and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
* \"NY\" = \"New York\", are considered exact matches.
*/
@javax.annotation.Nullable
public List getAlternativesAsExact() {
return alternativesAsExact;
}
public IndexSettings setAdvancedSyntaxFeatures(List advancedSyntaxFeatures) {
this.advancedSyntaxFeatures = advancedSyntaxFeatures;
return this;
}
public IndexSettings addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem) {
if (this.advancedSyntaxFeatures == null) {
this.advancedSyntaxFeatures = new ArrayList<>();
}
this.advancedSyntaxFeatures.add(advancedSyntaxFeaturesItem);
return this;
}
/**
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must
* match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact
* string \"iPhone case\". - `excludeWords`. Query words prefixed with a `-` must not occur in a
* record. For example, `search -engine` matches records that contain \"search\" but not
* \"engine\". This setting only has an effect if `advancedSyntax` is true.
*/
@javax.annotation.Nullable
public List getAdvancedSyntaxFeatures() {
return advancedSyntaxFeatures;
}
public IndexSettings setDistinct(Distinct distinct) {
this.distinct = distinct;
return this;
}
/** Get distinct */
@javax.annotation.Nullable
public Distinct getDistinct() {
return distinct;
}
public IndexSettings setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight) {
this.replaceSynonymsInHighlight = replaceSynonymsInHighlight;
return this;
}
/**
* Whether to replace a highlighted word with the matched synonym. By default, the original words
* are highlighted even if a synonym matches. For example, with `home` as a synonym for `house`
* and a search for `home`, records matching either \"home\" or \"house\" are included in the
* search results, and either \"home\" or \"house\" are highlighted. With
* `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,
* but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
*/
@javax.annotation.Nullable
public Boolean getReplaceSynonymsInHighlight() {
return replaceSynonymsInHighlight;
}
public IndexSettings setMinProximity(Integer minProximity) {
this.minProximity = minProximity;
return this;
}
/**
* Minimum proximity score for two matching words. This adjusts the [Proximity ranking
* criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
* by equally scoring matches that are farther apart. For example, if `minProximity` is 2,
* neighboring matches and matches with one word between them would have the same score. minimum:
* 1 maximum: 7
*/
@javax.annotation.Nullable
public Integer getMinProximity() {
return minProximity;
}
public IndexSettings setResponseFields(List responseFields) {
this.responseFields = responseFields;
return this;
}
public IndexSettings addResponseFields(String responseFieldsItem) {
if (this.responseFields == null) {
this.responseFields = new ArrayList<>();
}
this.responseFields.add(responseFieldsItem);
return this;
}
/**
* Properties to include in the API response of `search` and `browse` requests. By default, all
* response properties are included. To reduce the response size, you can select, which attributes
* should be included. You can't exclude these properties: `message`, `warning`, `cursor`,
* `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the
* `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI.
*/
@javax.annotation.Nullable
public List getResponseFields() {
return responseFields;
}
public IndexSettings setMaxValuesPerFacet(Integer maxValuesPerFacet) {
this.maxValuesPerFacet = maxValuesPerFacet;
return this;
}
/** Maximum number of facet values to return for each facet. maximum: 1000 */
@javax.annotation.Nullable
public Integer getMaxValuesPerFacet() {
return maxValuesPerFacet;
}
public IndexSettings setSortFacetValuesBy(String sortFacetValuesBy) {
this.sortFacetValuesBy = sortFacetValuesBy;
return this;
}
/**
* Order in which to retrieve facet values. - `count`. Facet values are retrieved by decreasing
* count. The count is the number of matching records containing this facet value. - `alpha`.
* Retrieve facet values alphabetically. This setting doesn't influence how facet values are
* displayed in your UI (see `renderingContent`). For more information, see [facet value
* display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
*/
@javax.annotation.Nullable
public String getSortFacetValuesBy() {
return sortFacetValuesBy;
}
public IndexSettings setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity) {
this.attributeCriteriaComputedByMinProximity = attributeCriteriaComputedByMinProximity;
return this;
}
/**
* Whether the best matching attribute should be determined by minimum proximity. This setting
* only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking`
* setting. If true, the best matching attribute is selected based on the minimum proximity of
* multiple matches. Otherwise, the best matching attribute is determined by the order in the
* `searchableAttributes` setting.
*/
@javax.annotation.Nullable
public Boolean getAttributeCriteriaComputedByMinProximity() {
return attributeCriteriaComputedByMinProximity;
}
public IndexSettings setRenderingContent(RenderingContent renderingContent) {
this.renderingContent = renderingContent;
return this;
}
/** Get renderingContent */
@javax.annotation.Nullable
public RenderingContent getRenderingContent() {
return renderingContent;
}
public IndexSettings setEnableReRanking(Boolean enableReRanking) {
this.enableReRanking = enableReRanking;
return this;
}
/**
* Whether this search will use [Dynamic
* Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has
* an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
*/
@javax.annotation.Nullable
public Boolean getEnableReRanking() {
return enableReRanking;
}
public IndexSettings setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter) {
this.reRankingApplyFilter = reRankingApplyFilter;
return this;
}
/** Get reRankingApplyFilter */
@javax.annotation.Nullable
public ReRankingApplyFilter getReRankingApplyFilter() {
return reRankingApplyFilter;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
IndexSettings indexSettings = (IndexSettings) o;
return (
Objects.equals(this.attributesForFaceting, indexSettings.attributesForFaceting) &&
Objects.equals(this.replicas, indexSettings.replicas) &&
Objects.equals(this.paginationLimitedTo, indexSettings.paginationLimitedTo) &&
Objects.equals(this.unretrievableAttributes, indexSettings.unretrievableAttributes) &&
Objects.equals(this.disableTypoToleranceOnWords, indexSettings.disableTypoToleranceOnWords) &&
Objects.equals(this.attributesToTransliterate, indexSettings.attributesToTransliterate) &&
Objects.equals(this.camelCaseAttributes, indexSettings.camelCaseAttributes) &&
Objects.equals(this.decompoundedAttributes, indexSettings.decompoundedAttributes) &&
Objects.equals(this.indexLanguages, indexSettings.indexLanguages) &&
Objects.equals(this.disablePrefixOnAttributes, indexSettings.disablePrefixOnAttributes) &&
Objects.equals(this.allowCompressionOfIntegerArray, indexSettings.allowCompressionOfIntegerArray) &&
Objects.equals(this.numericAttributesForFiltering, indexSettings.numericAttributesForFiltering) &&
Objects.equals(this.separatorsToIndex, indexSettings.separatorsToIndex) &&
Objects.equals(this.searchableAttributes, indexSettings.searchableAttributes) &&
Objects.equals(this.userData, indexSettings.userData) &&
Objects.equals(this.customNormalization, indexSettings.customNormalization) &&
Objects.equals(this.attributeForDistinct, indexSettings.attributeForDistinct) &&
Objects.equals(this.maxFacetHits, indexSettings.maxFacetHits) &&
Objects.equals(this.attributesToRetrieve, indexSettings.attributesToRetrieve) &&
Objects.equals(this.ranking, indexSettings.ranking) &&
Objects.equals(this.customRanking, indexSettings.customRanking) &&
Objects.equals(this.relevancyStrictness, indexSettings.relevancyStrictness) &&
Objects.equals(this.attributesToHighlight, indexSettings.attributesToHighlight) &&
Objects.equals(this.attributesToSnippet, indexSettings.attributesToSnippet) &&
Objects.equals(this.highlightPreTag, indexSettings.highlightPreTag) &&
Objects.equals(this.highlightPostTag, indexSettings.highlightPostTag) &&
Objects.equals(this.snippetEllipsisText, indexSettings.snippetEllipsisText) &&
Objects.equals(this.restrictHighlightAndSnippetArrays, indexSettings.restrictHighlightAndSnippetArrays) &&
Objects.equals(this.hitsPerPage, indexSettings.hitsPerPage) &&
Objects.equals(this.minWordSizefor1Typo, indexSettings.minWordSizefor1Typo) &&
Objects.equals(this.minWordSizefor2Typos, indexSettings.minWordSizefor2Typos) &&
Objects.equals(this.typoTolerance, indexSettings.typoTolerance) &&
Objects.equals(this.allowTyposOnNumericTokens, indexSettings.allowTyposOnNumericTokens) &&
Objects.equals(this.disableTypoToleranceOnAttributes, indexSettings.disableTypoToleranceOnAttributes) &&
Objects.equals(this.ignorePlurals, indexSettings.ignorePlurals) &&
Objects.equals(this.removeStopWords, indexSettings.removeStopWords) &&
Objects.equals(this.keepDiacriticsOnCharacters, indexSettings.keepDiacriticsOnCharacters) &&
Objects.equals(this.queryLanguages, indexSettings.queryLanguages) &&
Objects.equals(this.decompoundQuery, indexSettings.decompoundQuery) &&
Objects.equals(this.enableRules, indexSettings.enableRules) &&
Objects.equals(this.enablePersonalization, indexSettings.enablePersonalization) &&
Objects.equals(this.queryType, indexSettings.queryType) &&
Objects.equals(this.removeWordsIfNoResults, indexSettings.removeWordsIfNoResults) &&
Objects.equals(this.mode, indexSettings.mode) &&
Objects.equals(this.semanticSearch, indexSettings.semanticSearch) &&
Objects.equals(this.advancedSyntax, indexSettings.advancedSyntax) &&
Objects.equals(this.optionalWords, indexSettings.optionalWords) &&
Objects.equals(this.disableExactOnAttributes, indexSettings.disableExactOnAttributes) &&
Objects.equals(this.exactOnSingleWordQuery, indexSettings.exactOnSingleWordQuery) &&
Objects.equals(this.alternativesAsExact, indexSettings.alternativesAsExact) &&
Objects.equals(this.advancedSyntaxFeatures, indexSettings.advancedSyntaxFeatures) &&
Objects.equals(this.distinct, indexSettings.distinct) &&
Objects.equals(this.replaceSynonymsInHighlight, indexSettings.replaceSynonymsInHighlight) &&
Objects.equals(this.minProximity, indexSettings.minProximity) &&
Objects.equals(this.responseFields, indexSettings.responseFields) &&
Objects.equals(this.maxValuesPerFacet, indexSettings.maxValuesPerFacet) &&
Objects.equals(this.sortFacetValuesBy, indexSettings.sortFacetValuesBy) &&
Objects.equals(this.attributeCriteriaComputedByMinProximity, indexSettings.attributeCriteriaComputedByMinProximity) &&
Objects.equals(this.renderingContent, indexSettings.renderingContent) &&
Objects.equals(this.enableReRanking, indexSettings.enableReRanking) &&
Objects.equals(this.reRankingApplyFilter, indexSettings.reRankingApplyFilter)
);
}
@Override
public int hashCode() {
return Objects.hash(
attributesForFaceting,
replicas,
paginationLimitedTo,
unretrievableAttributes,
disableTypoToleranceOnWords,
attributesToTransliterate,
camelCaseAttributes,
decompoundedAttributes,
indexLanguages,
disablePrefixOnAttributes,
allowCompressionOfIntegerArray,
numericAttributesForFiltering,
separatorsToIndex,
searchableAttributes,
userData,
customNormalization,
attributeForDistinct,
maxFacetHits,
attributesToRetrieve,
ranking,
customRanking,
relevancyStrictness,
attributesToHighlight,
attributesToSnippet,
highlightPreTag,
highlightPostTag,
snippetEllipsisText,
restrictHighlightAndSnippetArrays,
hitsPerPage,
minWordSizefor1Typo,
minWordSizefor2Typos,
typoTolerance,
allowTyposOnNumericTokens,
disableTypoToleranceOnAttributes,
ignorePlurals,
removeStopWords,
keepDiacriticsOnCharacters,
queryLanguages,
decompoundQuery,
enableRules,
enablePersonalization,
queryType,
removeWordsIfNoResults,
mode,
semanticSearch,
advancedSyntax,
optionalWords,
disableExactOnAttributes,
exactOnSingleWordQuery,
alternativesAsExact,
advancedSyntaxFeatures,
distinct,
replaceSynonymsInHighlight,
minProximity,
responseFields,
maxValuesPerFacet,
sortFacetValuesBy,
attributeCriteriaComputedByMinProximity,
renderingContent,
enableReRanking,
reRankingApplyFilter
);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class IndexSettings {\n");
sb.append(" attributesForFaceting: ").append(toIndentedString(attributesForFaceting)).append("\n");
sb.append(" replicas: ").append(toIndentedString(replicas)).append("\n");
sb.append(" paginationLimitedTo: ").append(toIndentedString(paginationLimitedTo)).append("\n");
sb.append(" unretrievableAttributes: ").append(toIndentedString(unretrievableAttributes)).append("\n");
sb.append(" disableTypoToleranceOnWords: ").append(toIndentedString(disableTypoToleranceOnWords)).append("\n");
sb.append(" attributesToTransliterate: ").append(toIndentedString(attributesToTransliterate)).append("\n");
sb.append(" camelCaseAttributes: ").append(toIndentedString(camelCaseAttributes)).append("\n");
sb.append(" decompoundedAttributes: ").append(toIndentedString(decompoundedAttributes)).append("\n");
sb.append(" indexLanguages: ").append(toIndentedString(indexLanguages)).append("\n");
sb.append(" disablePrefixOnAttributes: ").append(toIndentedString(disablePrefixOnAttributes)).append("\n");
sb.append(" allowCompressionOfIntegerArray: ").append(toIndentedString(allowCompressionOfIntegerArray)).append("\n");
sb.append(" numericAttributesForFiltering: ").append(toIndentedString(numericAttributesForFiltering)).append("\n");
sb.append(" separatorsToIndex: ").append(toIndentedString(separatorsToIndex)).append("\n");
sb.append(" searchableAttributes: ").append(toIndentedString(searchableAttributes)).append("\n");
sb.append(" userData: ").append(toIndentedString(userData)).append("\n");
sb.append(" customNormalization: ").append(toIndentedString(customNormalization)).append("\n");
sb.append(" attributeForDistinct: ").append(toIndentedString(attributeForDistinct)).append("\n");
sb.append(" maxFacetHits: ").append(toIndentedString(maxFacetHits)).append("\n");
sb.append(" attributesToRetrieve: ").append(toIndentedString(attributesToRetrieve)).append("\n");
sb.append(" ranking: ").append(toIndentedString(ranking)).append("\n");
sb.append(" customRanking: ").append(toIndentedString(customRanking)).append("\n");
sb.append(" relevancyStrictness: ").append(toIndentedString(relevancyStrictness)).append("\n");
sb.append(" attributesToHighlight: ").append(toIndentedString(attributesToHighlight)).append("\n");
sb.append(" attributesToSnippet: ").append(toIndentedString(attributesToSnippet)).append("\n");
sb.append(" highlightPreTag: ").append(toIndentedString(highlightPreTag)).append("\n");
sb.append(" highlightPostTag: ").append(toIndentedString(highlightPostTag)).append("\n");
sb.append(" snippetEllipsisText: ").append(toIndentedString(snippetEllipsisText)).append("\n");
sb.append(" restrictHighlightAndSnippetArrays: ").append(toIndentedString(restrictHighlightAndSnippetArrays)).append("\n");
sb.append(" hitsPerPage: ").append(toIndentedString(hitsPerPage)).append("\n");
sb.append(" minWordSizefor1Typo: ").append(toIndentedString(minWordSizefor1Typo)).append("\n");
sb.append(" minWordSizefor2Typos: ").append(toIndentedString(minWordSizefor2Typos)).append("\n");
sb.append(" typoTolerance: ").append(toIndentedString(typoTolerance)).append("\n");
sb.append(" allowTyposOnNumericTokens: ").append(toIndentedString(allowTyposOnNumericTokens)).append("\n");
sb.append(" disableTypoToleranceOnAttributes: ").append(toIndentedString(disableTypoToleranceOnAttributes)).append("\n");
sb.append(" ignorePlurals: ").append(toIndentedString(ignorePlurals)).append("\n");
sb.append(" removeStopWords: ").append(toIndentedString(removeStopWords)).append("\n");
sb.append(" keepDiacriticsOnCharacters: ").append(toIndentedString(keepDiacriticsOnCharacters)).append("\n");
sb.append(" queryLanguages: ").append(toIndentedString(queryLanguages)).append("\n");
sb.append(" decompoundQuery: ").append(toIndentedString(decompoundQuery)).append("\n");
sb.append(" enableRules: ").append(toIndentedString(enableRules)).append("\n");
sb.append(" enablePersonalization: ").append(toIndentedString(enablePersonalization)).append("\n");
sb.append(" queryType: ").append(toIndentedString(queryType)).append("\n");
sb.append(" removeWordsIfNoResults: ").append(toIndentedString(removeWordsIfNoResults)).append("\n");
sb.append(" mode: ").append(toIndentedString(mode)).append("\n");
sb.append(" semanticSearch: ").append(toIndentedString(semanticSearch)).append("\n");
sb.append(" advancedSyntax: ").append(toIndentedString(advancedSyntax)).append("\n");
sb.append(" optionalWords: ").append(toIndentedString(optionalWords)).append("\n");
sb.append(" disableExactOnAttributes: ").append(toIndentedString(disableExactOnAttributes)).append("\n");
sb.append(" exactOnSingleWordQuery: ").append(toIndentedString(exactOnSingleWordQuery)).append("\n");
sb.append(" alternativesAsExact: ").append(toIndentedString(alternativesAsExact)).append("\n");
sb.append(" advancedSyntaxFeatures: ").append(toIndentedString(advancedSyntaxFeatures)).append("\n");
sb.append(" distinct: ").append(toIndentedString(distinct)).append("\n");
sb.append(" replaceSynonymsInHighlight: ").append(toIndentedString(replaceSynonymsInHighlight)).append("\n");
sb.append(" minProximity: ").append(toIndentedString(minProximity)).append("\n");
sb.append(" responseFields: ").append(toIndentedString(responseFields)).append("\n");
sb.append(" maxValuesPerFacet: ").append(toIndentedString(maxValuesPerFacet)).append("\n");
sb.append(" sortFacetValuesBy: ").append(toIndentedString(sortFacetValuesBy)).append("\n");
sb
.append(" attributeCriteriaComputedByMinProximity: ")
.append(toIndentedString(attributeCriteriaComputedByMinProximity))
.append("\n");
sb.append(" renderingContent: ").append(toIndentedString(renderingContent)).append("\n");
sb.append(" enableReRanking: ").append(toIndentedString(enableReRanking)).append("\n");
sb.append(" reRankingApplyFilter: ").append(toIndentedString(reRankingApplyFilter)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy