Package co.elastic.clients.elasticsearch.core

Class OpenPointInTimeRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.OpenPointInTimeRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class OpenPointInTimeRequest extends RequestBase implements JsonpSerializable
Open a point in time.

A search request by default runs 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.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowPartialSearchResults

      @Nullable public final Boolean allowPartialSearchResults()
      If false, creating a point in time request when a shard is missing or unavailable will throw an exception. If true, the point in time will contain all the shards that are available at the time of the request.

      API name: allow_partial_search_results

    • 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

    • indexFilter

      @Nullable public final Query indexFilter()
      Allows to filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • 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

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupOpenPointInTimeRequestDeserializer

      protected static void setupOpenPointInTimeRequestDeserializer(ObjectDeserializer<OpenPointInTimeRequest.Builder> op)