Package co.elastic.clients.elasticsearch.core.termvectors

Class Filter

java.lang.Object

co.elastic.clients.elasticsearch.core.termvectors.Filter

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Filter
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Filter.Builder	Builder for Filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Filter>	_DESERIALIZER	Json deserializer for Filter

Method Summary

Modifier and Type	Method	Description
final Integer	maxDocFreq()	Ignore words which occur in more than this many docs.
final Integer	maxNumTerms()	Maximum number of terms that must be returned per field.
final Integer	maxTermFreq()	Ignore words with more than this frequency in the source doc.
final Integer	maxWordLength()	The maximum word length above which words will be ignored.
final Integer	minDocFreq()	Ignore terms which do not occur in at least this many docs.
final Integer	minTermFreq()	Ignore words with less than this frequency in the source doc.
final Integer	minWordLength()	The minimum word length below which words will be ignored.
static Filter	of(Function<Filter.Builder,ObjectBuilder<Filter>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFilterDeserializer(ObjectDeserializer<Filter.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Filter> _DESERIALIZER

Json deserializer for Filter

Method Details

of

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

maxDocFreq

@Nullable
public final Integer maxDocFreq()

Ignore words which occur in more than this many docs. Defaults to unbounded.

API name: max_doc_freq

maxNumTerms

@Nullable
public final Integer maxNumTerms()

Maximum number of terms that must 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. Defaults to unbounded.

API name: max_term_freq

maxWordLength

@Nullable
public final Integer maxWordLength()

The maximum word length above which words will be ignored. Defaults to 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 below which words will be ignored.

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)

toString

public String toString()

Overrides:

toString in class Object

setupFilterDeserializer

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