Package co.elastic.clients.elasticsearch.core

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 for OpenPointInTimeRequest.

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 final Endpoint<OpenPointInTimeRequest,OpenPointInTimeResponse,ErrorResponse>	_ENDPOINT	Endpoint "open_point_in_time".

Method Summary

Modifier and Type	Method	Description
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final List<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 indices
final Time	keepAlive()	Required - Extends the time to live of the corresponding point in time.
static OpenPointInTimeRequest	of(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)
final String	preference()	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

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> _ENDPOINT

Endpoint "open_point_in_time".

Method Details

of

public static OpenPointInTimeRequest of(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)

expandWildcards

public final List<ExpandWildcard> 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 as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

public final List<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 indices

API name: index

keepAlive

public final Time keepAlive()

Required - Extends the time to live of the corresponding point in time.

API name: keep_alive

preference

@Nullable
public final String preference()

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

routing

@Nullable
public final String routing()

Custom value used to route operations to a specific shard.

API name: routing