Package co.elastic.clients.elasticsearch.core.search

Class SourceFilter

java.lang.Object

co.elastic.clients.elasticsearch.core.search.SourceFilter

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SourceFilter
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<String>	excludes()	A list of fields to exclude from the returned source.
final Boolean	excludeVectors()	If true, vector fields are excluded from the returned source.
final List<String>	includes()	A list of fields to include in the returned source.
static SourceFilter	of(Function<SourceFilter.Builder,ObjectBuilder<SourceFilter>> 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	setupSourceFilterDeserializer(ObjectDeserializer<SourceFilter.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<SourceFilter> _DESERIALIZER

Json deserializer for SourceFilter

Method Details

of

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

excludeVectors

@Nullable
public final Boolean excludeVectors()

If true, vector fields are excluded from the returned source.

This option takes precedence over includes: any vector field will remain excluded even if it matches an includes rule.

API name: exclude_vectors

excludes

public final List<String> excludes()

A list of fields to exclude from the returned source.

API name: excludes

includes

public final List<String> includes()

A list of fields to include in the returned source.

API name: includes

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

setupSourceFilterDeserializer

protected static void setupSourceFilterDeserializer(ObjectDeserializer<SourceFilter.Builder> op)