Package org.elasticsearch.search.fetch.subphase

Class FetchSourceContext

java.lang.Object

org.elasticsearch.search.fetch.subphase.FetchSourceContext

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class FetchSourceContext
extends Object
implements Writeable, ToXContentObject

Context used to fetch the _source.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static FetchSourceContext	DO_NOT_FETCH_SOURCE
static ParseField	EXCLUDES_FIELD
static FetchSourceContext	FETCH_SOURCE
static ParseField	INCLUDES_FIELD

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FetchSourceContext(boolean fetchSource)
FetchSourceContext(boolean fetchSource, String[] includes, String[] excludes)
FetchSourceContext(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String[]	excludes()
boolean	fetchSource()
static FetchSourceContext	fromXContent(XContentParser parser)
Function<Map<String,?>,Map<String,Object>>	getFilter()	Returns a filter function that expects the source map as an input and returns the filtered map.
int	hashCode()
String[]	includes()
static FetchSourceContext	parseFromRestRequest(RestRequest request)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

INCLUDES_FIELD

public static final ParseField INCLUDES_FIELD

EXCLUDES_FIELD

public static final ParseField EXCLUDES_FIELD

FETCH_SOURCE

public static final FetchSourceContext FETCH_SOURCE

DO_NOT_FETCH_SOURCE

public static final FetchSourceContext DO_NOT_FETCH_SOURCE

Constructor Detail

FetchSourceContext

public FetchSourceContext(boolean fetchSource,
                          String[] includes,
                          String[] excludes)

FetchSourceContext

public FetchSourceContext(boolean fetchSource)

FetchSourceContext

public FetchSourceContext(StreamInput in)
                   throws IOException

Throws:

IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fetchSource

public boolean fetchSource()

includes

public String[] includes()

excludes

public String[] excludes()

parseFromRestRequest

public static FetchSourceContext parseFromRestRequest(RestRequest request)

fromXContent

public static FetchSourceContext fromXContent(XContentParser parser)
                                       throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFilter

public Function<Map<String,?>,Map<String,Object>> getFilter()

Returns a filter function that expects the source map as an input and returns the filtered map.