|
@@ -6,19 +6,20 @@
|
|
|
|
|
|
The most simple Delete Request needs is:
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-request/; print if $tag; $tag = $tag || /tag::delete-request/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-request]
|
|
|
--------------------------------------------------
|
|
|
<1> Index name
|
|
|
<2> Type
|
|
|
<3> Document id
|
|
|
|
|
|
+
|
|
|
You can also provide the following properties:
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-request-props/; print if $tag; $tag = $tag || /tag::delete-request-props/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-request-props]
|
|
|
--------------------------------------------------
|
|
|
<1> Timeout
|
|
|
<2> Timeout as String
|
|
@@ -30,17 +31,17 @@ sys2::[perl -ne 'exit if /end::delete-request-props/; print if $tag; $tag = $tag
|
|
|
[[java-rest-high-document-delete-sync]]
|
|
|
==== Execution
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-execute/; print if $tag; $tag = $tag || /tag::delete-execute/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-execute]
|
|
|
--------------------------------------------------
|
|
|
|
|
|
[[java-rest-high-document-delete-async]]
|
|
|
==== Asynchronous Execution
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-execute-async/; print if $tag; $tag = $tag || /tag::delete-execute-async/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-execute-async]
|
|
|
--------------------------------------------------
|
|
|
<1> Implement if needed when execution did not throw an exception
|
|
|
<2> Implement if needed in case of failure
|
|
@@ -50,18 +51,17 @@ sys2::[perl -ne 'exit if /end::delete-execute-async/; print if $tag; $tag = $tag
|
|
|
|
|
|
In the Delete Response object, you can check for example the result of the operation:
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-notfound/; print if $tag; $tag = $tag || /tag::delete-notfound/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-notfound]
|
|
|
--------------------------------------------------
|
|
|
<1> Do something if we did not find the document which should have been deleted
|
|
|
|
|
|
Note that if you have a version conflict because you defined the version within the
|
|
|
<<java-rest-high-document-delete-request>>, it will raise an `ElasticsearchException` like:
|
|
|
|
|
|
-["source","java",subs="attributes,callouts"]
|
|
|
+["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
-sys2::[perl -ne 'exit if /end::delete-conflict/; print if $tag; $tag = $tag || /tag::delete-conflict/' {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DeleteDocumentationIT.java]
|
|
|
+include-tagged::{doc-tests}/DeleteDocumentationIT.java[delete-conflict]
|
|
|
--------------------------------------------------
|
|
|
<1> We got a version conflict
|
|
|
-
|