Package org.opensearch.client.opensearch.indices

Class ExistsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ExistsRequest

public class ExistsRequest
extends RequestBase

Returns information about whether a particular index exists.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<ExistsRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.exists".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Ignore if a wildcard expression resolves to no concrete indices (default: false)
java.util.List<ExpandWildcard>	expandWildcards()	Whether wildcard expressions should get expanded to open or closed indices (default: open)
java.lang.Boolean	flatSettings()	Return settings in flat format (default: false)
java.lang.Boolean	ignoreUnavailable()	Ignore unavailable indexes (default: false)
java.lang.Boolean	includeDefaults()	Whether to return all default setting for each of the indices.
java.util.List<java.lang.String>	index()	Required - A comma-separated list of index names
java.lang.Boolean	local()	Return local information, do not retrieve the state from cluster-manager node (default: false)
static ExistsRequest	of(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<ExistsRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.exists".

Method Detail

of

public static ExistsRequest of(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

Ignore if a wildcard expression resolves to no concrete indices (default: false)

API name: allow_no_indices

expandWildcards

public final java.util.List<ExpandWildcard> expandWildcards()

Whether wildcard expressions should get expanded to open or closed indices (default: open)

API name: expand_wildcards

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

Ignore unavailable indexes (default: false)

API name: ignore_unavailable

includeDefaults

@Nullable
public final java.lang.Boolean includeDefaults()

Whether to return all default setting for each of the indices.

API name: include_defaults

index

public final java.util.List<java.lang.String> index()

Required - A comma-separated list of index names

API name: index

local

@Nullable
public final java.lang.Boolean local()

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

API name: local