Introduce DataFrameAnalyticsConfig update API (#58302)

This commit is contained in:
Przemysław Witek 2020-06-29 09:26:31 +02:00 committed by GitHub
parent 38185e5da0
commit 3953de4c98
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 1919 additions and 34 deletions

View file

@ -0,0 +1,51 @@
--
:api: update-data-frame-analytics
:request: UpdateDataFrameAnalyticsRequest
:response: UpdateDataFrameAnalyticsResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Update {dfanalytics-jobs} API
Updates an existing {dfanalytics-job}.
The API accepts an +{request}+ object as a request and returns an +{response}+.
[id="{upid}-{api}-request"]
==== Update {dfanalytics-jobs} request
An +{request}+ requires the following argument:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The configuration of the {dfanalytics-job} update to perform
[id="{upid}-{api}-config"]
==== {dfanalytics-cap} configuration update
The `DataFrameAnalyticsConfigUpdate` object contains all the details about the {dfanalytics-job}
configuration update and contains the following arguments:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-config-update]
--------------------------------------------------
<1> The {dfanalytics-job} ID
<2> The human-readable description
<3> The memory limit for the model created as part of the analysis process
[id="{upid}-{api}-query-config"]
include::../execution.asciidoc[]
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ contains the updated {dfanalytics-job}.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------

View file

@ -322,6 +322,7 @@ The Java High Level REST Client supports the following Machine Learning APIs:
* <<{upid}-get-data-frame-analytics>>
* <<{upid}-get-data-frame-analytics-stats>>
* <<{upid}-put-data-frame-analytics>>
* <<{upid}-update-data-frame-analytics>>
* <<{upid}-delete-data-frame-analytics>>
* <<{upid}-start-data-frame-analytics>>
* <<{upid}-stop-data-frame-analytics>>
@ -379,6 +380,7 @@ include::ml/estimate-model-memory.asciidoc[]
include::ml/get-data-frame-analytics.asciidoc[]
include::ml/get-data-frame-analytics-stats.asciidoc[]
include::ml/put-data-frame-analytics.asciidoc[]
include::ml/update-data-frame-analytics.asciidoc[]
include::ml/delete-data-frame-analytics.asciidoc[]
include::ml/start-data-frame-analytics.asciidoc[]
include::ml/stop-data-frame-analytics.asciidoc[]