elasticsearch/docs/java-rest/high-level
Benjamin Trent b9dc522cb4
[7.x] [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)(#63092) (#63177)
* [ML] adding for_export flag for ml plugin GET resource APIs (#63092)

This adds the new `for_export` flag to the following APIs:

- GET _ml/anomaly_detection/<job_id>
- GET _ml/datafeeds/<datafeed_id>
- GET _ml/data_frame/analytics/<analytics_id>

The flag is designed for cloning or exporting configuration objects to later be put into the same cluster or a separate cluster.

The following fields are not returned in the objects:

- any field that is not user settable (e.g. version, create_time)
- any field that is a calculated default value (e.g. datafeed chunking_config)
- any field that would effectively require changing to be of use (e.g. datafeed job_id)
- any field that is automatically set via another Elastic stack process (e.g. anomaly job custom_settings.created_by)

closes https://github.com/elastic/elasticsearch/issues/63055

* [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)

When exporting and cloning ml configurations in a cluster it can be
frustrating to remove all the fields that were generated by
the plugin. Especially as the number of these fields change
from version to version.

This flag, exclude_generated, allows the GET config APIs to return
configurations with these generated fields removed.

APIs supporting this flag:
- GET _ml/anomaly_detection/<job_id>
- GET _ml/datafeeds/<datafeed_id>
- GET _ml/data_frame/analytics/<analytics_id>

The following fields are not returned in the objects:

- any field that is not user settable (e.g. version, create_time)
- any field that is a calculated default value (e.g. datafeed chunking_config)
- any field that is automatically set via another Elastic stack process (e.g. anomaly job custom_settings.created_by)

relates to #63055
2020-10-20 12:42:52 -04:00
..
asyncsearch [Docs] Add HLRC Async Search API documentation (#54353) 2020-03-30 15:37:22 +02:00
ccr Allow follower indices to override leader settings (#58103) 2020-06-18 11:56:06 -04:00
cluster [7.x] HLRC: document index template v2 and component template APIs (#56136) (#56225) 2020-05-05 19:51:54 +01:00
document [DOCS] Prune Search your data content (#61303) (#61462) 2020-08-24 09:31:53 -04:00
enrich Add HLRC support for enrich execute policy API (#47991) 2019-10-14 19:55:48 +02:00
graph [DOCS] Adds missing icons to Graph HLRC APIs (#46630) 2019-09-11 15:22:10 -07:00
ilm SLM Start/Stop HLRC and docs (#47966) 2019-10-14 16:56:31 -06:00
indices [7.x] Rename template V2 classes to ComposableTemplate (#57183) (#57232) 2020-05-27 11:01:59 -06:00
ingest REST high-level client: add simulate pipeline API (#31158) 2018-06-22 09:59:04 +02:00
licensing HLRC: add support for get license basic/trial status API (#33176) 2018-11-13 15:52:59 +01:00
migration Remove Migration Upgrade and Assistance APIs (#40075) 2019-03-18 13:46:56 -06:00
miscellaneous HLRC: Convert xpack methods to client side objects (#40705) 2019-04-04 11:06:44 -05:00
ml [7.x] [ML] adding new flag exclude_generated that removes generated fields in GET config APIs (#63899)(#63092) (#63177) 2020-10-20 12:42:52 -04:00
rollup [DOCS] Add experimental tag to rollup APIs (#63206) 2020-10-05 13:22:11 -07:00
script HLRC: Add put stored script support to high-level rest client (#31323) 2018-09-09 13:47:47 +02:00
search [Docs] Update multi-search.asciidoc (#56284) 2020-05-06 16:54:09 +02:00
security Adding authentication information to access token create APIs (#62490) (#63841) 2020-10-16 20:50:03 +02:00
snapshot Add Restore Snapshot High Level REST API 2018-07-24 16:17:09 +02:00
tasks Broadcast cancellation to only nodes have outstanding child tasks (#54312) 2020-04-06 11:11:29 -04:00
transform [Transform] add new exclude_generated flag to GET transform (#63093) (#63947) 2020-10-20 12:38:41 -04:00
watcher [Docs] Fix typo in start-watch-service.asciidoc (#57182) 2020-05-27 15:50:31 +02:00
aggs-builders.asciidoc Fix broken links to aggregation javadoc (#59083) (#59319) 2020-07-11 13:28:03 +01:00
execution-no-req.asciidoc [DOCS] Fixes terms in HLRC data frame transform APIs (#44838) (#44865) 2019-07-25 10:08:38 -07:00
execution.asciidoc [DOCS] Fixes terms in HLRC data frame transform APIs (#44838) (#44865) 2019-07-25 10:08:38 -07:00
getting-started.asciidoc [DOCS] Fix typo in Java HLRC docs (#60863) (#61264) 2020-08-18 09:09:10 -04:00
index.asciidoc [7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) 2020-06-01 16:42:53 -07:00
java-builders.asciidoc Docs: Cut down on high level rest client copy-and-paste-ness (#34125) 2018-09-28 14:48:11 -04:00
migration.asciidoc Docs: Pin two IDs in the rest client (#40785) 2019-04-04 12:03:36 -04:00
query-builders.asciidoc Search - added HLRC support for PinnedQueryBuilder (#45779) (#45853) 2019-08-23 09:22:17 +01:00
supported-apis.asciidoc Cache API key doc to reduce traffic to the security index (#59376) (#63319) 2020-10-06 23:49:23 +11:00