Package org.opensearch.client.opensearch.core.termvectors

Class Filter.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.termvectors.Filter.Builder
All Implemented Interfaces:
CopyableBuilder<Filter.Builder,Filter>, MutableBuilder<Filter.Builder,Filter>, ObjectBuilder<Filter>
Enclosing class:
Filter
public static class Filter.Builder extends ObjectBuilderBase implements CopyableBuilder<Filter.Builder,Filter>
Builder for Filter.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public Filter.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<Filter.Builder,Filter>
      Returns:
      a new builder instance.

    • maxDocFreq

      @Nonnull public final Filter.Builder maxDocFreq(@Nullable Integer value)
      Ignores words that appear in more than the specified number of documents. Default is unbounded.

      API name: max_doc_freq

    • maxNumTerms

      @Nonnull public final Filter.Builder maxNumTerms(@Nullable Integer value)
      The maximum number of terms that should be returned per field.

      API name: max_num_terms

    • maxTermFreq

      @Nonnull public final Filter.Builder maxTermFreq(@Nullable Integer value)
      Ignore words with more than this frequency in the source doc. Default is unbounded.

      API name: max_term_freq

    • maxWordLength

      @Nonnull public final Filter.Builder maxWordLength(@Nullable Integer value)
      The maximum word length. Words longer than this value will be ignored. Default is unbounded.

      API name: max_word_length

    • minDocFreq

      @Nonnull public final Filter.Builder minDocFreq(@Nullable Integer value)
      Ignore terms which do not occur in at least this many docs.

      API name: min_doc_freq

    • minTermFreq

      @Nonnull public final Filter.Builder minTermFreq(@Nullable Integer value)
      Ignore words with less than this frequency in the source doc.

      API name: min_term_freq

    • minWordLength

      @Nonnull public final Filter.Builder minWordLength(@Nullable Integer value)
      The minimum word length. Words shorter than this value will be ignored. Default is 0.

      API name: min_word_length

    • build

      @Nonnull public Filter build()
      Builds a Filter.
      Specified by:
      build in interface ObjectBuilder<Filter>
      Throws:
      NullPointerException - if some of the required fields are null.