Module org.elasticsearch.server
Class FetchSourceContext
java.lang.Object
org.elasticsearch.search.fetch.subphase.FetchSourceContext
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
Context used to fetch the
_source
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.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
Modifier and TypeFieldDescriptionstatic final FetchSourceContext
static final ParseField
static final FetchSourceContext
static final ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionboolean
String[]
excludes()
boolean
static FetchSourceContext
fromXContent
(XContentParser parser) Returns a filter function that expects the source map as an input and returns the filtered map.int
hashCode()
String[]
includes()
static FetchSourceContext
of
(boolean fetchSource) static FetchSourceContext
static FetchSourceContext
parseFromRestRequest
(RestRequest request) static FetchSourceContext
readFrom
(StreamInput in) 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.xcontent.ToXContentObject
isFragment
-
Field Details
-
INCLUDES_FIELD
-
EXCLUDES_FIELD
-
FETCH_SOURCE
-
DO_NOT_FETCH_SOURCE
-
-
Method Details
-
of
-
of
public static FetchSourceContext of(boolean fetchSource, @Nullable String[] includes, @Nullable String[] excludes) -
readFrom
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
fetchSource
public boolean fetchSource() -
includes
-
excludes
-
parseFromRestRequest
-
fromXContent
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
getFilter
Returns a filter function that expects the source map as an input and returns the filtered map.
-