Package co.elastic.clients.elasticsearch.indices

Class ExistsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ExistsRequest

public class ExistsRequest
extends RequestBase

Check indices.

Check if one or more indices, index aliases, or data streams exist.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ExistsRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.exists".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	A setting that does two separate checks on the index expression.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	flatSettings()	If true, returns settings in flat format.
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.
final Boolean	includeDefaults()	If true, return all default settings in the response.
final List<String>	index()	Required - Comma-separated list of data streams, indices, and aliases.
final Boolean	local()	If true, the request retrieves information from the local node only.
static ExistsRequest	of(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
ExistsRequest.Builder	rebuild()

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<ExistsRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.exists".

Method Details

of

public static ExistsRequest of(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> 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

flatSettings

@Nullable
public final Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

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

includeDefaults

@Nullable
public final Boolean includeDefaults()

If true, return all default settings in the response.

API name: include_defaults

index

public final List<String> index()

Required - Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

API name: index

local

@Nullable
public final Boolean local()

If true, the request retrieves information from the local node only.

API name: local

rebuild

public ExistsRequest.Builder rebuild()

Returns:

New ExistsRequest.Builder initialized with field values of this instance