honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/painless/painless-api-reference/index.asciidoc

62 lines
4.9 KiB
Plaintext
Raw Normal View History

Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
// This file is auto-generated. Do not edit.
[DOCS] Setting up separate Painless book.
2017-05-12 19:17:06 -04:00
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
[cols="<3,^3,^3"]
|====
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
|Aggregation Selector | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggregation-selector, Specialized API>>
|Aggs | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggs, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Aggs Combine | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggs-combine, Specialized API>>
|Aggs Init | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggs-init, Specialized API>>
|Aggs Map | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggs-map, Specialized API>>
|Aggs Reduce | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-aggs-reduce, Specialized API>>
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
|Analysis | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-analysis, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Bucket Aggregation | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-bucket-aggregation, Specialized API>>
Add static section whitelist info to api docs generation (#41870) This change adds imported methods, class bindings, and instance bindings to the documentation generation for the Painless Context APIs.
2019-05-08 13:29:02 -04:00
|Field | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-field, Specialized API>>
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
|Filter | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-filter, Specialized API>>
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
|Ingest | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-ingest, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Interval | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-interval, Specialized API>>
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
|Moving Function | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-moving-function, Specialized API>>
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
|Number Sort | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-number-sort, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Painless Test | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-painless-test, Specialized API>>
|Processor Conditional | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-processor-conditional, Specialized API>>
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
|Score | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-score, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Script Heuristic | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-script-heuristic, Specialized API>>
|Similarity | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-similarity, Specialized API>>
|Similarity Weight | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-similarity-weight, Specialized API>>
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
|String Sort | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-string-sort, Specialized API>>
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
|Template | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-template, Specialized API>>
|Terms Set | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-terms-set, Specialized API>>
|Update | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-update, Specialized API>>
|Watcher Condition | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-watcher-condition, Specialized API>>
|Watcher Transform | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-watcher-transform, Specialized API>>
|Xpack Template | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-xpack-template, Specialized API>>
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
|====
include::painless-api-reference-shared/index.asciidoc[]
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
include::painless-api-reference-aggregation-selector/index.asciidoc[]
include::painless-api-reference-aggs/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-aggs-combine/index.asciidoc[]
include::painless-api-reference-aggs-init/index.asciidoc[]
include::painless-api-reference-aggs-map/index.asciidoc[]
include::painless-api-reference-aggs-reduce/index.asciidoc[]
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
include::painless-api-reference-analysis/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-bucket-aggregation/index.asciidoc[]
Add static section whitelist info to api docs generation (#41870) This change adds imported methods, class bindings, and instance bindings to the documentation generation for the Painless Context APIs.
2019-05-08 13:29:02 -04:00
include::painless-api-reference-field/index.asciidoc[]
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
include::painless-api-reference-filter/index.asciidoc[]
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
include::painless-api-reference-ingest/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-interval/index.asciidoc[]
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
include::painless-api-reference-moving-function/index.asciidoc[]
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
include::painless-api-reference-number-sort/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-painless-test/index.asciidoc[]
include::painless-api-reference-processor-conditional/index.asciidoc[]
Task to generate Painless API's per context (#41233) This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
2019-04-23 12:10:47 -04:00
include::painless-api-reference-score/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-script-heuristic/index.asciidoc[]
include::painless-api-reference-similarity/index.asciidoc[]
include::painless-api-reference-similarity-weight/index.asciidoc[]
Scripting: fix generateContextDoc path and url #59676 (#59722) * Add doc runtime class path * Use getAllHttpSocketURI.get(0) instead of getAllHttpSocketURI to get a single test cluster URL rather than a list Backport: 3057e0f
2020-07-16 16:03:36 -04:00
include::painless-api-reference-string-sort/index.asciidoc[]
Scripting: Update ctx docs with sha augment #59719 (#59736) Backport: 352a90c
2020-07-16 19:33:08 -04:00
include::painless-api-reference-template/index.asciidoc[]
include::painless-api-reference-terms-set/index.asciidoc[]
include::painless-api-reference-update/index.asciidoc[]
include::painless-api-reference-watcher-condition/index.asciidoc[]
include::painless-api-reference-watcher-transform/index.asciidoc[]
include::painless-api-reference-xpack-template/index.asciidoc[]