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

Class SynonymTokenFilterBase.AbstractBuilder<BuilderT extends SynonymTokenFilterBase.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.analysis.SynonymTokenFilterBase.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
SynonymGraphTokenFilter.Builder, SynonymTokenFilter.Builder
Enclosing class:
SynonymTokenFilterBase
public abstract static class SynonymTokenFilterBase.AbstractBuilder<BuilderT extends SynonymTokenFilterBase.AbstractBuilder<BuilderT>> extends TokenFilterBase.AbstractBuilder<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • expand

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

      API name: expand

    • format

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

      API name: format

    • lenient

      public final BuilderT lenient(@Nullable Boolean value)
      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 BuilderT synonyms(List<String> list)
      Used to define inline synonyms.

      API name: synonyms

      Adds all elements of list to synonyms.

    • synonyms

      public final BuilderT synonyms(String value, String... values)
      Used to define inline synonyms.

      API name: synonyms

      Adds one or more values to synonyms.

    • synonymsPath

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

      API name: synonyms_path

    • synonymsSet

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

      API name: synonyms_set

    • tokenizer

      @Deprecated public final BuilderT tokenizer(@Nullable String value)
      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

      public final BuilderT updateable(@Nullable Boolean value)
      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