Package org.opensearch.client.opensearch.indices

Class DeleteIndexRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.DeleteIndexRequest

public class DeleteIndexRequest
extends RequestBase

Deletes an index.

Nested Class Summary

Nested Classes

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

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<DeleteIndexRequest,DeleteIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.delete".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Ignore if a wildcard expression resolves to no concrete indices (default: false)
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.util.List<ExpandWildcard>	expandWildcards()	Whether wildcard expressions should get expanded to open, closed, or hidden indices
java.lang.Boolean	ignoreUnavailable()	Ignore unavailable indexes (default: false)
java.util.List<java.lang.String>	index()	Required - A comma-separated list of indices to delete; use _all or * string to delete all indices
Time	masterTimeout()	Deprecated.
static DeleteIndexRequest	of(java.util.function.Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)
Time	timeout()	Explicit operation timeout

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<DeleteIndexRequest,DeleteIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.delete".

Method Detail

of

public static DeleteIndexRequest of(java.util.function.Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> 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, closed, or hidden indices

API name: expand_wildcards

ignoreUnavailable

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

Ignore unavailable indexes (default: false)

API name: ignore_unavailable

index

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

Required - A comma-separated list of indices to delete; use _all or * string to delete all indices

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout