Package co.elastic.clients.elasticsearch.indices

Class ResolveIndexRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.ResolveIndexRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ResolveIndexRequest extends RequestBase implements JsonpSerializable
Resolve indices.

Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      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 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.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      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 List<IndexMode> mode()
      Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.

      API name: mode

    • name

      public final List<String> name()
      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

    • projectRouting

      @Nullable public final String projectRouting()
      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

    • 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)

    • rebuild

      public ResolveIndexRequest.Builder rebuild()
      Returns:
      New ResolveIndexRequest.Builder initialized with field values of this instance

    • setupResolveIndexRequestDeserializer

      protected static void setupResolveIndexRequestDeserializer(ObjectDeserializer<ResolveIndexRequest.Builder> op)