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/index.asciidoc

133 lines
4.9 KiB
Plaintext
Raw Normal View History

Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
--
:api: index
:request: IndexRequest
:response: IndexResponse
--
[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
=== 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
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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
==== 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
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
An +{request}+ requires the following 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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-string]
[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
Deprecate types in index API (#36575) * Deprecate types in index API - deprecate type-based constructors of IndexRequest - update tests to use typeless IndexRequest constructors - no yaml tests as they have been already added in #35790 Relates to #35190
2018-12-18 08:53:49 -05:00
<2> Document id for the request
<3> Document source provided as a `String`
[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] 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] expand examples on providing mappings for create index and put mapping (#28483) * [DOCS] expand examples on providing mappings for create index and put mapping The create index API and put mappings API docs the for high-level Java REST client didn't have a lot of info on how to provide mappings. This commit adds some examples.
2018-02-02 04:32:24 -05:00
The document source can be provided in different ways in addition to the
`String` example shown above:
[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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-map]
[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> Document source provided as a `Map` which gets automatically converted
to JSON format
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-xcontent]
[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> Document source provided as an `XContentBuilder` object, the Elasticsearch
built-in helpers to generate JSON content
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-shortcut]
[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> 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"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-op-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> 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"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-request-pipeline]
[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> The name of the ingest pipeline to be executed before indexing the document
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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
==== 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
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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 (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"]
--------------------------------------------------
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -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
Same will happen in case `opType` was set to `create` and a document with
Deprecate types in index API (#36575) * Deprecate types in index API - deprecate type-based constructors of IndexRequest - update tests to use typeless IndexRequest constructors - no yaml tests as they have been already added in #35790 Relates to #35190
2018-12-18 08:53:49 -05:00
same index and id already existed:
[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 HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
include-tagged::{doc-tests-file}[{api}-optype]
[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