Package co.elastic.clients.elasticsearch.indices

Class ResolveClusterRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ResolveClusterRequest

public class ResolveClusterRequest
extends RequestBase

Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ResolveClusterRequest,ResolveClusterResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.resolve_cluster".

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	ignoreThrottled()	If true, concrete, expanded or aliased indices are ignored when frozen.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final List<String>	name()	Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
static ResolveClusterRequest	of(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> fn)

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<ResolveClusterRequest,ResolveClusterResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.resolve_cluster".

Method Details

of

public static ResolveClusterRequest of(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> 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. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

ignoreThrottled

@Nullable
public final Boolean ignoreThrottled()

If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false.

API name: ignore_throttled

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If false, the request returns an error if it targets a missing or closed index. Defaults to false.

API name: ignore_unavailable

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