Package org.elasticsearch.search.builder

Class PointInTimeBuilder

java.lang.Object

org.elasticsearch.search.builder.PointInTimeBuilder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class PointInTimeBuilder
extends Object
implements Writeable, 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.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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PointInTimeBuilder(String pitID)
PointInTimeBuilder(StreamInput in)

Method Summary

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

isFragment

Constructor Details

PointInTimeBuilder

public PointInTimeBuilder(String pitID)

PointInTimeBuilder

public PointInTimeBuilder(StreamInput in)
                   throws IOException

Throws:

IOException

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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static PointInTimeBuilder fromXContent(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(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 TimeValue getKeepAlive()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object