Class PointInTimeBuilder

java.lang.Object
org.elasticsearch.search.builder.PointInTimeBuilder
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public final class PointInTimeBuilder extends Object implements Writeable, org.elasticsearch.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.
  • Constructor Details

  • Method Details

    • writeTo

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

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • fromXContent

      public static PointInTimeBuilder fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • getEncodedId

      public 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.core.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.
    • setKeepAlive

      public PointInTimeBuilder setKeepAlive(String 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.core.TimeValue getKeepAlive()
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object