Package co.elastic.clients.elasticsearch.indices

Class ExistsAliasRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ExistsAliasRequest

public class ExistsAliasRequest
extends RequestBase

Returns information about whether a particular alias exists.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final List<String>	index()	A comma-separated list of index names to filter aliases
final Boolean	local()	Return local information, do not retrieve the state from master node (default: false)
final List<String>	name()	Required - A comma-separated list of alias names to return
static ExistsAliasRequest	of(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> 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<ExistsAliasRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.exists_alias".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final List<String> index()

A comma-separated list of index names to filter aliases

API name: index

local

@Nullable
public final Boolean local()

Return local information, do not retrieve the state from master node (default: false)

API name: local

name

public final List<String> name()

Required - A comma-separated list of alias names to return

API name: name