Class DeleteRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.DeleteRequest
Removes a document from the 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 - The document IDfinal Long
only perform the delete operation if the last operation that has changed the document has the specified primary termfinal Long
ifSeqNo()
only perform the delete operation if the last operation that has changed the document has the specified sequence numberfinal String
index()
Required - The name of the indexstatic DeleteRequest
final Refresh
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.final String
routing()
Specific routing valuefinal Time
timeout()
Explicit operation timeoutfinal String
type()
The type of the documentfinal Long
version()
Explicit version number for concurrency controlfinal VersionType
Specific version typefinal WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the delete operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "delete
".
-
-
Method Details
-
of
-
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
-
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
-