github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

[ML] Data Frame HLRC Preview API (#40206)

Browse source
This commit is contained in:
David Kyle 2019-03-20 13:38:41 +00:00 • committed by GitHub
parent df9f0f729f
commit 217dc089c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 651 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc Normal file
View file

@ -0,0 +1,32 @@
--
:api: preview-data-frame-transform
:request: PreviewDataFrameTransformRequest
:response: PreviewDataFrameTransformResponse
--
[id="{upid}-{api}"]
=== Preview Data Frame Transform API
The Preview Data Frame Transform API is used to preview the results of
a {dataframe-transform}.
The API accepts a +{request}+ object as a request and returns a +{response}+.
[id="{upid}-{api}-request"]
==== Preview Data Frame Request
A +{request}+ takes a single argument: a valid data frame transform config.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The transform Id may be null for the preview
<2> The destination may be null for the preview
<3> The configuration of the {dataframe-job} to preview
include::../execution.asciidoc[]
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ contains the preview documents

2
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -556,10 +556,12 @@ The Java High Level REST Client supports the following Data Frame APIs:
* <<{upid}-put-data-frame-transform>>
* <<{upid}-delete-data-frame-transform>>
* <<{upid}-preview-data-frame-transform>>
* <<{upid}-start-data-frame-transform>>
* <<{upid}-stop-data-frame-transform>>
include::dataframe/put_data_frame.asciidoc[]
include::dataframe/delete_data_frame.asciidoc[]
include::dataframe/preview_data_frame.asciidoc[]
include::dataframe/start_data_frame.asciidoc[]
include::dataframe/stop_data_frame.asciidoc[]