Package org.elasticsearch.search.fetch.subphase

Class FetchSourceContext

java.lang.Object
org.elasticsearch.search.fetch.subphase.FetchSourceContext
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class FetchSourceContext
extends java.lang.Object
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

    Fields 
    Modifier and Type Field Description
    static FetchSourceContext DO_NOT_FETCH_SOURCE  
    static org.elasticsearch.common.ParseField EXCLUDES_FIELD  
    static FetchSourceContext FETCH_SOURCE  
    static org.elasticsearch.common.ParseField INCLUDES_FIELD  

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • 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​(org.elasticsearch.common.xcontent.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)  
    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.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Field Details

  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • fetchSource

      public boolean fetchSource()

    • includes

      public java.lang.String[] includes()

    • excludes

      public java.lang.String[] excludes()

    • parseFromRestRequest

      public static FetchSourceContext parseFromRestRequest​(RestRequest request)

    • fromXContent

      public static FetchSourceContext fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      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

    • 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.