Class DeleteIndexRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.DeleteIndexRequest
Deletes one or more indices.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<DeleteIndexRequest,
DeleteIndexResponse, ErrorResponse> Endpoint "indices.delete
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Required - Comma-separated list of indices to delete.final Time
Period to wait for a connection to the master node.static DeleteIndexRequest
final Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "indices.delete
".
-
-
Method Details
-
of
public static DeleteIndexRequest of(Function<DeleteIndexRequest.Builder, ObjectBuilder<DeleteIndexRequest>> fn) -
allowNoIndices
Iffalse
, 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.API name:
allow_no_indices
-
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
index
Required - Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*
) or_all
. To use wildcards or_all
, set theaction.destructive_requires_name
cluster setting tofalse
.API name:
index
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-