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/apis/_index.asciidoc

150 lines
6.1 KiB
Plaintext
Raw Normal View History

[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
[[java-rest-high-document-index]]
[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
=== Index 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
[[java-rest-high-document-index-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
==== Index 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
An `IndexRequest` requires the following arguments:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-string]
--------------------------------------------------
<1> Index
<2> Type
<3> Document id
<4> Document source provided as a `String`
[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
==== Providing the document source
[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 document source can be provided in different ways:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-map]
--------------------------------------------------
<1> Document source provided as a `Map` which gets automatically converted
to JSON format
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-xcontent]
--------------------------------------------------
<1> Document source provided as an `XContentBuilder` object, the Elasticsearch
built-in helpers to generate JSON content
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-shortcut]
--------------------------------------------------
<1> Document source provided as `Object` key-pairs, which gets converted to
JSON format
[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"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-routing]
--------------------------------------------------
<1> Routing value
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-parent]
--------------------------------------------------
<1> Parent value
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-timeout]
--------------------------------------------------
<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"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-refresh]
--------------------------------------------------
<1> Refresh policy as a `WriteRequest.RefreshPolicy` instance
<2> Refresh policy as a `String`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-version]
--------------------------------------------------
<1> Version
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-version-type]
--------------------------------------------------
<1> Version type
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-op-type]
--------------------------------------------------
<1> Operation type provided as an `DocWriteRequest.OpType` value
<2> Operation type provided as a `String`: can be `create` or `update` (default)
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-request-pipeline]
--------------------------------------------------
<1> The name of the ingest pipeline to be executed before indexing the document
[[java-rest-high-document-index-sync]]
[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
==== Synchronous Execution
[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"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-execute]
--------------------------------------------------
[[java-rest-high-document-index-async]]
[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
==== Asynchronous Execution
[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"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-execute-async]
--------------------------------------------------
<1> Called when the execution is successfully completed. The response is
[DOCS] add docs for high level client get method (#25538) Document high level client get method
2017-07-05 05:57:57 -04:00
provided as an argument
<2> Called in case of failure. The raised exception is provided as an argument
[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
[[java-rest-high-document-index-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
==== Index 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
The returned `IndexResponse` allows to retrieve information about the executed
operation as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-response]
--------------------------------------------------
<1> Handle (if needed) the case where the document was created for the first
time
[Docs] Document Update API for Java High Level REST Client (#25536) This commit adds documentation for Java High Level REST Client's Update API.
2017-07-05 06:16:42 -04:00
<2> Handle (if needed) the case where the document was rewritten as it was
[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
already existing
<3> Handle the situation where number of successful shards is less than
total shards
<4> Handle the potential failures
If there is a version conflict, an `ElasticsearchException` will
be thrown:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-conflict]
--------------------------------------------------
[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
Same will happen in case `opType` was set to `create` and a document with
same index, type and id already existed:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/CRUDDocumentationIT.java[index-optype]
--------------------------------------------------
[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