Class DeleteIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteIndexRequest.Builder>
co.elastic.clients.elasticsearch.indices.DeleteIndexRequest.Builder
- All Implemented Interfaces:
WithJson<DeleteIndexRequest.Builder>
,ObjectBuilder<DeleteIndexRequest>
- Enclosing class:
- DeleteIndexRequest
public static class DeleteIndexRequest.Builder
extends RequestBase.AbstractBuilder<DeleteIndexRequest.Builder>
implements ObjectBuilder<DeleteIndexRequest>
Builder for
DeleteIndexRequest
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.build()
Builds aDeleteIndexRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.Required - Comma-separated list of indices to delete.Required - Comma-separated list of indices to delete.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.protected DeleteIndexRequest.Builder
self()
Period to wait for a response.Period to wait for a response.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final DeleteIndexRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) 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
Adds one or more values to
expandWildcards
. -
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
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
-
masterTimeout
public final DeleteIndexRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<DeleteIndexRequest.Builder>
-
build
Builds aDeleteIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<DeleteIndexRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-