org.elasticsearch.search.fetch.source

Class FetchSourceContext

java.lang.Object

org.elasticsearch.search.fetch.source.FetchSourceContext

All Implemented Interfaces:

Streamable, ToXContent

public class FetchSourceContext
extends java.lang.Object
implements Streamable, ToXContent

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and 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 and Description
FetchSourceContext(boolean fetchSource)
FetchSourceContext(boolean fetchSource, java.lang.String[] includes, java.lang.String[] excludes)
FetchSourceContext(java.lang.String include)
FetchSourceContext(java.lang.String[] includes)
FetchSourceContext(java.lang.String[] includes, java.lang.String[] excludes)
FetchSourceContext(java.lang.String include, java.lang.String exclude)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String[]	excludes()
FetchSourceContext	excludes(java.lang.String[] excludes)
boolean	fetchSource()
FetchSourceContext	fetchSource(boolean fetchSource)
void	fromXContent(XContentParser parser, QueryParseContext context)
int	hashCode()
java.lang.String[]	includes()
FetchSourceContext	includes(java.lang.String[] includes)
static FetchSourceContext	optionalReadFromStream(StreamInput in)
static void	optionalWriteToStream(FetchSourceContext context, StreamOutput out)
static FetchSourceContext	parse(XContentParser parser, QueryParseContext context)
static FetchSourceContext	parseFromRestRequest(RestRequest request)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

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)

FetchSourceContext

public FetchSourceContext(java.lang.String include)

FetchSourceContext

public FetchSourceContext(java.lang.String include,
                          java.lang.String exclude)

FetchSourceContext

public FetchSourceContext(java.lang.String[] includes)

FetchSourceContext

public FetchSourceContext(java.lang.String[] includes,
                          java.lang.String[] excludes)

FetchSourceContext

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

Method Detail

parse

public static FetchSourceContext parse(XContentParser parser,
                                       QueryParseContext context)
                                throws java.io.IOException

Throws:

java.io.IOException

fetchSource

public boolean fetchSource()

fetchSource

public FetchSourceContext fetchSource(boolean fetchSource)

includes

public java.lang.String[] includes()

includes

public FetchSourceContext includes(java.lang.String[] includes)

excludes

public java.lang.String[] excludes()

excludes

public FetchSourceContext excludes(java.lang.String[] excludes)

optionalReadFromStream

public static FetchSourceContext optionalReadFromStream(StreamInput in)
                                                 throws java.io.IOException

Throws:

java.io.IOException

optionalWriteToStream

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

Throws:

java.io.IOException

parseFromRestRequest

public static FetchSourceContext parseFromRestRequest(RestRequest request)

fromXContent

public void fromXContent(XContentParser parser,
                         QueryParseContext context)
                  throws java.io.IOException

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object