Package co.elastic.clients.elasticsearch.indices

Class ResolveIndexRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final ResolveIndexRequest.Builder allowNoIndices(@Nullable Boolean value)
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final ResolveIndexRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ResolveIndexRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final ResolveIndexRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • mode

      public final ResolveIndexRequest.Builder mode(List<IndexMode> list)
      Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.

      API name: mode

      Adds all elements of list to mode.

    • mode

      public final ResolveIndexRequest.Builder mode(IndexMode value, IndexMode... values)
      Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.

      API name: mode

      Adds one or more values to mode.

    • name

      public final ResolveIndexRequest.Builder name(List<String> list)
      Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

      API name: name

      Adds all elements of list to name.

    • name

      public final ResolveIndexRequest.Builder name(String value, String... values)
      Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

      API name: name

      Adds one or more values to name.

    • projectRouting

      public final ResolveIndexRequest.Builder projectRouting(@Nullable String value)
      Specifies a subset of projects to target 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

    • self

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

    • build

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