Package co.elastic.clients.elasticsearch.indices

Class ResolveIndexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ResolveIndexRequest

public class ResolveIndexRequest
extends RequestBase

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

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResolveIndexRequest.Builder	Builder for ResolveIndexRequest.

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<ResolveIndexRequest,ResolveIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.resolve_index".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
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<IndexMode>	mode()	Filter indices by index mode - standard, lookup, time_series, etc.
final List<String>	name()	Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
static ResolveIndexRequest	of(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)
final String	projectRouting()	Specifies a subset of projects to target using project metadata tags in a subset of Lucene query syntax.

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<ResolveIndexRequest,ResolveIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.resolve_index".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

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 missing or closed index.

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