Package co.elastic.clients.elasticsearch._types.analysis

Class SynonymTokenFilterBase

java.lang.Object
co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase
co.elastic.clients.elasticsearch._types.analysis.SynonymTokenFilterBase
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
SynonymGraphTokenFilter, SynonymTokenFilter
public abstract class SynonymTokenFilterBase extends TokenFilterBase
See Also:

  • Constructor Details

  • Method Details

    • expand

      @Nullable public final Boolean expand()
      Expands definitions for equivalent synonym rules. Defaults to true.

      API name: expand

    • format

      @Nullable public final SynonymFormat format()
      Sets the synonym rules format.

      API name: format

    • lenient

      @Nullable public final Boolean lenient()
      If true ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the updateable setting.

      API name: lenient

    • synonyms

      public final List<String> synonyms()
      Used to define inline synonyms.

      API name: synonyms

    • synonymsPath

      @Nullable public final String synonymsPath()
      Used to provide a synonym file. This path must be absolute or relative to the config location.

      API name: synonyms_path

    • synonymsSet

      @Nullable public final String synonymsSet()
      Provide a synonym set created via Synonyms Management APIs.

      API name: synonyms_set

    • tokenizer

      @Deprecated @Nullable public final String tokenizer()
      Deprecated.
      6.0.0
      Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0.

      API name: tokenizer

    • updateable

      @Nullable public final Boolean updateable()
      If true allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to false.

      API name: updateable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class TokenFilterBase

    • setupSynonymTokenFilterBaseDeserializer

      protected static <BuilderT extends SynonymTokenFilterBase.AbstractBuilder<BuilderT>> void setupSynonymTokenFilterBaseDeserializer(ObjectDeserializer<BuilderT> op)