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 - Unique identifier for the document.final DeleteRequest.Builder
ifPrimaryTerm
(Long value) Only perform the operation if the document has this primary term.final DeleteRequest.Builder
Only perform the operation if the document has this sequence number.final DeleteRequest.Builder
Required - Name of the target index.final DeleteRequest.Builder
Iftrue
, Elasticsearch refreshes 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
do nothing with refreshes.final DeleteRequest.Builder
Custom value used to route operations to a specific shard.protected DeleteRequest.Builder
self()
final DeleteRequest.Builder
Period to wait for active shards.final DeleteRequest.Builder
Period to wait for active shards.final DeleteRequest.Builder
Explicit version number for concurrency control.final DeleteRequest.Builder
versionType
(VersionType value) Specific version type:external
,external_gte
.final DeleteRequest.Builder
The number of shard copies that must be active before proceeding with the operation.final DeleteRequest.Builder
The number of shard copies that must be active before proceeding with the 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 - Unique identifier for the document.API name:
id
-
ifPrimaryTerm
Only perform the operation if the document has this primary term.API name:
if_primary_term
-
ifSeqNo
Only perform the operation if the document has this sequence number.API name:
if_seq_no
-
index
Required - Name of the target index.API name:
index
-
refresh
Iftrue
, Elasticsearch refreshes 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
do nothing with refreshes. Valid values:true
,false
,wait_for
.API name:
refresh
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
timeout
Period to wait for active shards.API name:
timeout
-
timeout
Period to wait for active shards.API name:
timeout
-
version
Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.API name:
version
-
versionType
Specific version type:external
,external_gte
.API name:
version_type
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForActiveShards
public final DeleteRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (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.
-