Class DeleteRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteRequest.Builder>
co.elastic.clients.elasticsearch.core.DeleteRequest.Builder
- All Implemented Interfaces:
WithJson<DeleteRequest.Builder>
,ObjectBuilder<DeleteRequest>
- Enclosing class:
- DeleteRequest
public static class DeleteRequest.Builder
extends RequestBase.AbstractBuilder<DeleteRequest.Builder>
implements ObjectBuilder<DeleteRequest>
Builder for
DeleteRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aDeleteRequest
.final DeleteRequest.Builder
Required - The document IDfinal DeleteRequest.Builder
ifPrimaryTerm
(Long value) only perform the delete operation if the last operation that has changed the document has the specified primary termfinal DeleteRequest.Builder
only perform the delete operation if the last operation that has changed the document has the specified sequence numberfinal DeleteRequest.Builder
Required - The name of the indexfinal DeleteRequest.Builder
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.final DeleteRequest.Builder
Specific routing valueprotected DeleteRequest.Builder
self()
final DeleteRequest.Builder
Explicit operation timeoutfinal DeleteRequest.Builder
Explicit operation timeoutfinal DeleteRequest.Builder
The type of the documentfinal DeleteRequest.Builder
Explicit version number for concurrency controlfinal DeleteRequest.Builder
versionType
(VersionType value) Specific version typefinal DeleteRequest.Builder
Sets the number of shard copies that must be active before proceeding with the delete operation.final DeleteRequest.Builder
Sets the number of shard copies that must be active before proceeding with the delete operation.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
-
id
Required - The document IDAPI name:
id
-
ifPrimaryTerm
only perform the delete operation if the last operation that has changed the document has the specified primary termAPI name:
if_primary_term
-
ifSeqNo
only perform the delete operation if the last operation that has changed the document has the specified sequence numberAPI name:
if_seq_no
-
index
Required - The name of the indexAPI name:
index
-
refresh
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.API name:
refresh
-
routing
Specific routing valueAPI name:
routing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
type
The type of the documentAPI name:
type
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
waitForActiveShards
Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForActiveShards
public final DeleteRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<DeleteRequest.Builder>
-
build
Builds aDeleteRequest
.- Specified by:
build
in interfaceObjectBuilder<DeleteRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-