HLRC: Add ML delete filter action (#35382)

* HLRC: Add ML delete filter action

It adds delete ML filter action to the high level rest client.

Relates #29827
This commit is contained in:
Ignacio Vera 2018-11-19 11:25:35 +01:00 committed by GitHub
parent 2ee25c858d
commit ae6a33237f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 289 additions and 10 deletions

View file

@ -0,0 +1,33 @@
--
:api: delete-filter
:request: DeleteFilterRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Delete Filter API
Delete a {ml} filter.
The API accepts a +{request}+ and responds
with a +{response}+ object.
[id="{upid}-{api}-request"]
==== Delete Filter Request
A +{request}+ object requires a non-null `filterId`.
["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
---------------------------------------------------
<1> Constructing a new request referencing an existing filter
[id="{upid}-{api}-response"]
==== Delete Filter Response
The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
---------------------------------------------------
<1> `isAcknowledged` was the deletion request acknowledged or not
include::../execution.asciidoc[]

View file

@ -265,10 +265,11 @@ The Java High Level REST Client supports the following Machine Learning APIs:
* <<{upid}-put-calendar>>
* <<{upid}-delete-calendar>>
* <<{upid}-put-filter>>
* <<{upid}-get-model-snapshots>>
* <<{upid}-get-filters>>
* <<{upid}-delete-model-snapshot>>
* <<{upid}-update-filter>>
* <<{upid}-delete-filter>>
* <<{upid}-get-model-snapshots>>
include::ml/put-job.asciidoc[]
include::ml/get-job.asciidoc[]
@ -302,6 +303,7 @@ include::ml/get-model-snapshots.asciidoc[]
include::ml/get-filters.asciidoc[]
include::ml/delete-model-snapshot.asciidoc[]
include::ml/update-filter.asciidoc[]
include::ml/delete-filter.asciidoc[]
== Migration APIs