Class DeleteRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.DeleteRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
public final class DeleteRequest extends RequestBase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DeleteRequest.Builder
Builder forDeleteRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<DeleteRequest,DeleteResponse,ElasticsearchError>
ENDPOINT
Endpoint "delete
". -
Constructor Summary
Constructors Constructor Description DeleteRequest(DeleteRequest.Builder builder)
DeleteRequest(java.util.function.Function<DeleteRequest.Builder,DeleteRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.String
id()
Required - The document IDjava.lang.Long
ifPrimaryTerm()
only perform the delete operation if the last operation that has changed the document has the specified primary termjava.lang.Integer
ifSeqNo()
only perform the delete operation if the last operation that has changed the document has the specified sequence numberjava.lang.String
index()
Required - The name of the indexjakarta.json.JsonValue
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.java.lang.String
routing()
Specific routing valuejava.lang.String
timeout()
Explicit operation timeoutjava.lang.String
type()
The type of the documentjava.lang.Long
version()
Explicit version number for concurrency controlVersionType
versionType()
Specific version typejakarta.json.JsonValue
waitForActiveShards()
Sets the number of shard copies that must be active before proceeding with the delete operation.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ENDPOINT
Endpoint "delete
".
-
-
Constructor Details
-
DeleteRequest
-
DeleteRequest
-
-
Method Details
-
id
public java.lang.String id()Required - The document IDAPI name:
id
-
index
public java.lang.String index()Required - The name of the indexAPI name:
index
-
type
@Nullable public java.lang.String type()The type of the documentAPI name:
type
-
ifPrimaryTerm
@Nullable public java.lang.Long 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
@Nullable public java.lang.Integer ifSeqNo()only perform the delete operation if the last operation that has changed the document has the specified sequence numberAPI name:
if_seq_no
-
refresh
@Nullable public jakarta.json.JsonValue 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
@Nullable public java.lang.String routing()Specific routing valueAPI name:
routing
-
timeout
@Nullable public java.lang.String timeout()Explicit operation timeoutAPI name:
timeout
-
version
@Nullable public java.lang.Long version()Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
waitForActiveShards
@Nullable public jakarta.json.JsonValue 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
-