Class OpenPointInTimeRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.OpenPointInTimeRequest
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<OpenPointInTimeRequest,
OpenPointInTimeResponse, ErrorResponse> Endpoint "open_point_in_time
". -
Method Summary
Modifier and TypeMethodDescriptionfinal List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.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 indicesfinal Time
Required - Extends the time to live of the corresponding point in time.static OpenPointInTimeRequest
final String
Specifies the node or shard the operation should be performed on.final String
routing()
Custom value used to route operations to a specific shard.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<OpenPointInTimeRequest,OpenPointInTimeResponse, _ENDPOINTErrorResponse> Endpoint "open_point_in_time
".
-
-
Method Details
-
of
public static OpenPointInTimeRequest of(Function<OpenPointInTimeRequest.Builder, ObjectBuilder<OpenPointInTimeRequest>> fn) -
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
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 - Extends the time to live of the corresponding point in time.API name:
keep_alive
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-