Class DeleteRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.DeleteRequest
Removes a JSON document from the specified index.
- 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<DeleteRequest,
DeleteResponse, ErrorResponse> Endpoint "delete
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
id()
Required - Unique identifier for the document.final Long
Only perform the operation if the document has this primary term.final Long
ifSeqNo()
Only perform the operation if the document has this sequence number.final String
index()
Required - Name of the target index.static DeleteRequest
final Refresh
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.final String
routing()
Custom value used to route operations to a specific shard.final Time
timeout()
Period to wait for active shards.final Long
version()
Explicit version number for concurrency control.final VersionType
Specific version type:external
,external_gte
.final WaitForActiveShards
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "delete
".
-
-
Method Details
-
of
-
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
-
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
-