Module spring.data.elasticsearch

Package org.springframework.data.elasticsearch.core.query

Class FetchSourceFilter

java.lang.Object

org.springframework.data.elasticsearch.core.query.FetchSourceFilter

All Implemented Interfaces:

SourceFilter

public class FetchSourceFilter
extends Object
implements SourceFilter

SourceFilter implementation for providing includes and excludes.

Author:

Jon Tsiros, Peter-Josef Meisch

Constructor Summary

Constructors

Constructor	Description
FetchSourceFilter(Boolean fetchSource, String[] includes, String[] excludes)

Method Summary

Modifier and Type	Method	Description
Boolean	fetchSource()	Flag to set the _source parameter in a query to true or false.
String[]	getExcludes()
String[]	getIncludes()
static SourceFilter	of(Boolean fetchSource, String[] includes, String[] excludes)
static SourceFilter	of(Function<FetchSourceFilterBuilder,FetchSourceFilterBuilder> builderFunction)

Methods inherited from class java.lang.Object

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

Constructor Details

FetchSourceFilter

public FetchSourceFilter(@Nullable
 Boolean fetchSource,
 @Nullable
 String[] includes,
 @Nullable
 String[] excludes)

Method Details

of

public static SourceFilter of(@Nullable
 Boolean fetchSource,
 @Nullable
 String[] includes,
 @Nullable
 String[] excludes)

Since:

5.2

of

public static SourceFilter of(Function<FetchSourceFilterBuilder,FetchSourceFilterBuilder> builderFunction)

Since:

5.2

fetchSource

public Boolean fetchSource()

Description copied from interface: SourceFilter

Flag to set the _source parameter in a query to true or false. If this is not null, the values returned from getIncludes() and getExcludes() are ignored

Specified by:

fetchSource in interface SourceFilter

getIncludes

public String[] getIncludes()

Specified by:

getIncludes in interface SourceFilter

Returns:

the name of the fields to include in a response.

getExcludes

public String[] getExcludes()

Specified by:

getExcludes in interface SourceFilter

Returns:

the names of the fields to exclude from a response.