Class FetchSourceContext
java.lang.Object
org.elasticsearch.search.fetch.subphase.FetchSourceContext
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
public class FetchSourceContext extends java.lang.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
-
Constructor Summary
Constructors Constructor Description FetchSourceContext(boolean fetchSource)
FetchSourceContext(boolean fetchSource, java.lang.String[] includes, java.lang.String[] excludes)
FetchSourceContext(StreamInput in)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.String[]
excludes()
boolean
fetchSource()
static FetchSourceContext
fromXContent(XContentParser parser)
java.util.function.Function<java.util.Map<java.lang.String,?>,java.util.Map<java.lang.String,java.lang.Object>>
getFilter()
Returns a filter function that expects the source map as an input and returns the filtered map.int
hashCode()
java.lang.String[]
includes()
static FetchSourceContext
parseFromRestRequest(RestRequest request)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
Constructor Details
-
FetchSourceContext
public FetchSourceContext(boolean fetchSource, java.lang.String[] includes, java.lang.String[] excludes) -
FetchSourceContext
public FetchSourceContext(boolean fetchSource) -
FetchSourceContext
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
fetchSource
public boolean fetchSource() -
includes
public java.lang.String[] includes() -
excludes
public java.lang.String[] excludes() -
parseFromRestRequest
-
fromXContent
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
getFilter
public java.util.function.Function<java.util.Map<java.lang.String,?>,java.util.Map<java.lang.String,java.lang.Object>> getFilter()Returns a filter function that expects the source map as an input and returns the filtered map.
-