Package co.elastic.clients.elasticsearch.core

Class OpenPointInTimeRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder>
co.elastic.clients.elasticsearch.core.OpenPointInTimeRequest.Builder
All Implemented Interfaces:
WithJson<OpenPointInTimeRequest.Builder>, ObjectBuilder<OpenPointInTimeRequest>
Enclosing class:
OpenPointInTimeRequest
public static class OpenPointInTimeRequest.Builder extends RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder> implements ObjectBuilder<OpenPointInTimeRequest>
Builder for OpenPointInTimeRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowPartialSearchResults

      public final OpenPointInTimeRequest.Builder allowPartialSearchResults(@Nullable Boolean value)
      Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. 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 OpenPointInTimeRequest.Builder expandWildcards(List<ExpandWildcard> list)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final OpenPointInTimeRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final OpenPointInTimeRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      public final OpenPointInTimeRequest.Builder index(List<String> list)
      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

      Adds all elements of list to index.

    • index

      public final OpenPointInTimeRequest.Builder index(String value, String... values)
      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

      Adds one or more values to index.

    • indexFilter

      public final OpenPointInTimeRequest.Builder indexFilter(@Nullable Query value)
      Filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • indexFilter

      public final OpenPointInTimeRequest.Builder indexFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      Filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • indexFilter

      public final OpenPointInTimeRequest.Builder indexFilter(QueryVariant value)
      Filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • keepAlive

      public final OpenPointInTimeRequest.Builder keepAlive(Time value)
      Required - Extend the length of time that the point in time persists.

      API name: keep_alive

    • keepAlive

      public final OpenPointInTimeRequest.Builder keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Required - Extend the length of time that the point in time persists.

      API name: keep_alive

    • maxConcurrentShardRequests

      public final OpenPointInTimeRequest.Builder maxConcurrentShardRequests(@Nullable Integer value)
      Maximum number of concurrent shard requests that each sub-search request executes per node.

      API name: max_concurrent_shard_requests

    • preference

      public final OpenPointInTimeRequest.Builder preference(@Nullable String value)
      The node or shard the operation should be performed on. By default, it is random.

      API name: preference

    • projectRouting

      public final OpenPointInTimeRequest.Builder projectRouting(@Nullable String value)
      Specifies a subset of projects to target for the PIT request using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • routing

      public final OpenPointInTimeRequest.Builder routing(@Nullable String value)
      A custom value that is used to route operations to a specific shard.

      API name: routing

    • self

      protected OpenPointInTimeRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder>

    • build

      public OpenPointInTimeRequest build()
      Builds a OpenPointInTimeRequest.
      Specified by:
      build in interface ObjectBuilder<OpenPointInTimeRequest>
      Throws:
      NullPointerException - if some of the required fields are null.