elasticsearch/docs/java-rest/high-level/ml
Benjamin Trent 7bd6e78dae
[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
2020-10-02 08:29:19 -04:00
..
close-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-calendar-event.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-calendar-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-calendar.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-data-frame-analytics.asciidoc [ML] Fix race condition when force stopping DF analytics job (#57680) 2020-06-05 12:13:02 +03:00
delete-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-expired-data.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
delete-filter.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
delete-forecast.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
delete-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
delete-model-snapshot.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
delete-trained-models.asciidoc [ML] renames */inference* apis to */trained_models* (#63097) 2020-10-01 12:13:49 -04:00
estimate-model-memory.asciidoc [ML] Add a model memory estimation endpoint for anomaly detection (#53507) 2020-03-24 21:38:19 +00:00
evaluate-data-frame.asciidoc [ML] Implement AucRoc metric for classification - HLRC (#62304) 2020-09-30 10:53:45 +02:00
explain-data-frame-analytics.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
find-file-structure.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
flush-job.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
forecast-job.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
get-buckets.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-calendar-events.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-calendars.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-categories.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-data-frame-analytics-stats.asciidoc [DOCS] Fixes data frame analytics job terminology in HLRC (#46758) 2019-09-16 10:00:44 -07:00
get-data-frame-analytics.asciidoc [ML] adding for_export flag for ml plugin GET resource APIs (#63092) 2020-10-02 08:29:19 -04:00
get-datafeed-stats.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-datafeed.asciidoc [ML] adding for_export flag for ml plugin GET resource APIs (#63092) 2020-10-02 08:29:19 -04:00
get-filters.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-influencers.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-info.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-job-stats.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-job.asciidoc [ML] adding for_export flag for ml plugin GET resource APIs (#63092) 2020-10-02 08:29:19 -04:00
get-model-snapshots.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-overall-buckets.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-records.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
get-trained-models-stats.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
get-trained-models.asciidoc [ML] Add new include flag to GET inference/<model_id> API for model training metadata (#61922) 2020-09-18 07:11:38 -04:00
open-job.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55473) 2020-04-22 08:44:57 +01:00
post-calendar-event.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
post-data.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
preview-datafeed.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
put-calendar-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
put-calendar.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
put-data-frame-analytics.asciidoc [ML] adding docs + hlrc for data frame analysis feature_processors (#61149) 2020-08-24 12:00:44 -04:00
put-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
put-filter.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
put-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
put-trained-model.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
revert-model-snapshot.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
set-upgrade-mode.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
start-data-frame-analytics.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55473) 2020-04-22 08:44:57 +01:00
start-datafeed.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55473) 2020-04-22 08:44:57 +01:00
stop-data-frame-analytics.asciidoc [DOCS] Fixes data frame analytics job terminology in HLRC (#46758) 2019-09-16 10:00:44 -07:00
stop-datafeed.asciidoc [DOCS] Fix capitalization in HLRC ML APIs (#62010) 2020-09-04 13:40:02 -07:00
update-data-frame-analytics.asciidoc [ML] Data frame analytics max_num_threads setting (#59254) 2020-07-09 16:31:26 +03:00
update-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
update-filter.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
update-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00
update-model-snapshot.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:26:56 -07:00