honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/document/delete.asciidoc

92 lines
3.0 KiB
Plaintext
Raw Normal View History

Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
--
:api: delete
:request: DeleteRequest
:response: DeleteResponse
--
[id="{upid}-{api}"]
[DOCS] restructure java clients docs pages (#25517) This commit converts the low level client and high level client chapters into two parts, which allows each high level client supported api to be on a separate page and show up in the index on the right.
2017-07-04 04:58:57 -04:00
=== Delete API
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
[id="{upid}-{api}-request"]
[DOCS] restructure java clients docs pages (#25517) This commit converts the low level client and high level client chapters into two parts, which allows each high level client supported api to be on a separate page and show up in the index on the right.
2017-07-04 04:58:57 -04:00
==== Delete Request
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
HLRC: Delete role API (#34620) Adds the "Delete role" API to the high-level REST client.
2018-10-20 06:11:36 -04:00
A +{request}+ has no arguments
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Index
<2> Type
<3> Document id
[DOCS] restructure java clients docs pages (#25517) This commit converts the low level client and high level client chapters into two parts, which allows each high level client supported api to be on a separate page and show up in the index on the right.
2017-07-04 04:58:57 -04:00
==== Optional arguments
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
The following arguments can optionally be provided:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request-routing]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Routing value
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request-timeout]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Timeout to wait for primary shard to become available as a `TimeValue`
<2> Timeout to wait for primary shard to become available as a `String`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request-refresh]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Refresh policy as a `WriteRequest.RefreshPolicy` instance
<2> Refresh policy as a `String`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request-version]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Version
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request-version-type]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Version type
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include::../execution.asciidoc[]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
[id="{upid}-{api}-response"]
[DOCS] restructure java clients docs pages (#25517) This commit converts the low level client and high level client chapters into two parts, which allows each high level client supported api to be on a separate page and show up in the index on the right.
2017-07-04 04:58:57 -04:00
==== Delete Response
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
The returned +{response}+ allows to retrieve information about the executed
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
operation as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-response]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Handle the situation where number of successful shards is less than
total shards
<2> Handle the potential failures
It is also possible to check whether the document was found or not:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-notfound]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
<1> Do something if the document to be deleted was not found
If there is a version conflict, an `ElasticsearchException` will
be thrown:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-conflict]
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
--------------------------------------------------
[DOCS] add docs for high level client get method (#25538) Document high level client get method
2017-07-05 05:57:57 -04:00
<1> The raised exception indicates that a version conflict error was returned
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00