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

Class Filter

java.lang.Object
org.opensearch.client.opensearch.core.termvectors.Filter
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Filter.Builder,Filter>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class Filter extends Object implements PlainJsonSerializable, ToCopyableBuilder<Filter.Builder,Filter>

  • Field Details

  • Method Details

    • of

      public static Filter of(Function<Filter.Builder,ObjectBuilder<Filter>> fn)

    • maxDocFreq

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

      API name: max_doc_freq

    • maxNumTerms

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

      API name: max_num_terms

    • maxTermFreq

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

      API name: max_term_freq

    • maxWordLength

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

      API name: max_word_length

    • minDocFreq

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

      API name: min_doc_freq

    • minTermFreq

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

      API name: min_term_freq

    • minWordLength

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

      API name: min_word_length

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public Filter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static Filter.Builder builder()

    • setupFilterDeserializer

      protected static void setupFilterDeserializer(ObjectDeserializer<Filter.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object