org.elasticsearch.search.fetch.source

Class FetchSourceContext

java.lang.Object

org.elasticsearch.search.fetch.source.FetchSourceContext

All Implemented Interfaces:

Streamable

public class FetchSourceContext
extends Object
implements Streamable

Field Summary

Fields

Modifier and Type	Field and Description
static FetchSourceContext	DO_NOT_FETCH_SOURCE
static FetchSourceContext	FETCH_SOURCE

Constructor Summary

Constructors

Constructor and Description
FetchSourceContext(boolean fetchSource)
FetchSourceContext(boolean fetchSource, String[] includes, String[] excludes, boolean transform)
FetchSourceContext(String include)
FetchSourceContext(String[] includes)
FetchSourceContext(String[] includes, String[] excludes)
FetchSourceContext(String include, String exclude)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String[]	excludes()
FetchSourceContext	excludes(String[] excludes)
boolean	fetchSource()
FetchSourceContext	fetchSource(boolean fetchSource)
int	hashCode()
String[]	includes()
FetchSourceContext	includes(String[] includes)
static FetchSourceContext	optionalReadFromStream(StreamInput in)
static void	optionalWriteToStream(FetchSourceContext context, StreamOutput out)
static FetchSourceContext	parseFromRestRequest(RestRequest request)
void	readFrom(StreamInput in)
boolean	transformSource() Should the document be transformed after the source is loaded?
FetchSourceContext	transformSource(boolean transformSource) Should the document be transformed after the source is loaded?
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

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)

FetchSourceContext

public FetchSourceContext(String include)

FetchSourceContext

public FetchSourceContext(String include,
                  String exclude)

FetchSourceContext

public FetchSourceContext(String[] includes)

FetchSourceContext

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

FetchSourceContext

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

Method Detail

fetchSource

public boolean fetchSource()

fetchSource

public FetchSourceContext fetchSource(boolean fetchSource)

transformSource

public boolean transformSource()

Should the document be transformed after the source is loaded?

transformSource

public FetchSourceContext transformSource(boolean transformSource)

Should the document be transformed after the source is loaded?

Returns:

this for chaining

includes

public String[] includes()

includes

public FetchSourceContext includes(String[] includes)

excludes

public String[] excludes()

excludes

public FetchSourceContext excludes(String[] excludes)

optionalReadFromStream

public static FetchSourceContext optionalReadFromStream(StreamInput in)
                                                 throws IOException

Throws:

IOException

optionalWriteToStream

public static void optionalWriteToStream(FetchSourceContext context,
                         StreamOutput out)
                                  throws IOException

Throws:

IOException

parseFromRestRequest

public static FetchSourceContext parseFromRestRequest(RestRequest request)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object