Class OpenPointInTimeRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.OpenPointInTimeRequest
public class OpenPointInTimeRequest extends RequestBase
A search request by default executes against the most recent visible data of
the target indices, which is called point in time. Elasticsearch pit (point
in time) is a lightweight view into the state of the data as it existed when
initiated. In some cases, it’s preferred to perform multiple search requests
using the same point in time. For example, if refreshes happen between
search_after
requests, then the results of those requests might
not be consistent as changes happening between searches are only visible to
the more recent point in time.- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OpenPointInTimeRequest.Builder
Builder forOpenPointInTimeRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<OpenPointInTimeRequest,OpenPointInTimeResponse,ErrorResponse>
_ENDPOINT
Endpoint "open_point_in_time
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.util.List<java.lang.String>
index()
Required - A comma-separated list of index names to open point in time; use_all
or empty string to perform the operation on all indicesTime
keepAlive()
Required - Specific the time to live for the point in timestatic OpenPointInTimeRequest
of(java.util.function.Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
public static final Endpoint<OpenPointInTimeRequest,OpenPointInTimeResponse,ErrorResponse> _ENDPOINTEndpoint "open_point_in_time
".
-
-
Method Details
-
of
public static OpenPointInTimeRequest of(java.util.function.Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn) -
index
public final java.util.List<java.lang.String> index()Required - A comma-separated list of index names to open point in time; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
keepAlive
Required - Specific the time to live for the point in timeAPI name:
keep_alive
-