Class FetchSourceContext
org.elasticsearch.search.fetch.subphase.FetchSourceContext
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class FetchSourceContext
extends
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Context used to fetch the
_source
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 FetchSourceContext
static org.elasticsearch.common.xcontent.ParseField
static FetchSourceContext
static org.elasticsearch.common.xcontent.ParseField
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionFetchSourceContext(boolean fetchSource)
FetchSourceContext(boolean fetchSource, [] includes, [] excludes)
-
Method Summary
Modifier and TypeMethodDescriptionboolean
o)
[]
excludes()
boolean
static FetchSourceContext
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
<<,?>,<,>>
Returns a filter function that expects the source map as an input and returns the filtered map.int
hashCode()
[]
includes()
static FetchSourceContext
parseFromRestRequest(RestRequest request)
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.
, , , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
INCLUDES_FIELD
public static final org.elasticsearch.common.xcontent.ParseField INCLUDES_FIELD -
EXCLUDES_FIELD
public static final org.elasticsearch.common.xcontent.ParseField EXCLUDES_FIELD -
FETCH_SOURCE
-
DO_NOT_FETCH_SOURCE
-
-
Constructor Details
-
FetchSourceContext
public FetchSourceContext(boolean fetchSource, [] includes, [] excludes) -
FetchSourceContext
public FetchSourceContext(boolean fetchSource) -
FetchSourceContext
- Throws:
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
fetchSource
public boolean fetchSource() -
includes
public [] includes() -
excludes
public [] excludes() -
parseFromRestRequest
-
fromXContent
public static FetchSourceContext fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-
getFilter
public <<,?>,<,>> getFilter()Returns a filter function that expects the source map as an input and returns the filtered map.
-