java.lang.Object
org.elasticsearch.search.builder.PointInTimeBuilder
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
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.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic PointInTimeBuilderfromXContent(XContentParser parser) Returns the encoded id of this point in timegetSearchContextId(NamedWriteableRegistry namedWriteableRegistry) Returns the search context of this point in time from its encoded id.inthashCode()setKeepAlive(String keepAlive) If specified, the search layer will keep this point in time around for at least the given keep-alive.setKeepAlive(TimeValue keepAlive) If specified, the search layer will keep this point in time around for at least the given keep-alive.booleanReturnstrueif the point in time is explicitly released when returning the response.toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
PointInTimeBuilder
-
PointInTimeBuilder
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
getEncodedId
Returns the encoded id of this point in time -
getSearchContextId
Returns the search context of this point in time from its encoded id. -
setKeepAlive
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
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
-
singleSession
public boolean singleSession()Returnstrueif the point in time is explicitly released when returning the response. -
equals
-
hashCode
public int hashCode()
-