Package org.elasticsearch.search.builder

Class PointInTimeBuilder

java.lang.Object
org.elasticsearch.search.builder.PointInTimeBuilder
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class PointInTimeBuilder
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
A search request with a point in time will execute using the reader contexts associated with that point time instead of the latest reader contexts.

  • 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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    PointInTimeBuilder​(java.lang.String encodedId)  
    PointInTimeBuilder​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static PointInTimeBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.lang.String getEncodedId()
    Returns the encoded id of this point in time
    org.elasticsearch.common.unit.TimeValue getKeepAlive()  
    SearchContextId getSearchContextId​(NamedWriteableRegistry namedWriteableRegistry)
    Returns the search context of this point in time from its encoded id.
    int hashCode()  
    PointInTimeBuilder setKeepAlive​(org.elasticsearch.common.unit.TimeValue keepAlive)
    If specified, the search layer will keep this point in time around for at least the given keep-alive.
    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

  • Constructor Details

    • PointInTimeBuilder

      public PointInTimeBuilder​(java.lang.String encodedId)

    • PointInTimeBuilder

      public PointInTimeBuilder​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • 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

    • 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

    • fromXContent

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

    • getEncodedId

      public java.lang.String getEncodedId()
      Returns the encoded id of this point in time

    • getSearchContextId

      public SearchContextId getSearchContextId​(NamedWriteableRegistry namedWriteableRegistry)
      Returns the search context of this point in time from its encoded id.

    • setKeepAlive

      public PointInTimeBuilder setKeepAlive​(org.elasticsearch.common.unit.TimeValue keepAlive)
      If specified, the search layer will keep this point in time around for at least the given keep-alive. Otherwise, the point in time will be kept around until the original keep alive elapsed.

    • getKeepAlive

      @Nullable public org.elasticsearch.common.unit.TimeValue getKeepAlive()

    • 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