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 Get Stats API (#40327)

Browse source
This commit is contained in:
David Kyle 2019-03-26 08:57:12 +00:00 • committed by GitHub
parent d5015c1196
commit 474ef8b4ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
27 changed files with 1312 additions and 249 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc Normal file
View file

@ -0,0 +1,39 @@
--
:api: get-data-frame-transform-stats
:request: GetDataFrameTransformStatsRequest
:response: GetDataFrameTransformStatsResponse
--
[id="{upid}-{api}"]
=== Get Data Frame Transform Stats API
The Get Data Frame Transform Stats API is used read the operational statistics
of one or more {dataframe-transform}s.
The API accepts a +{request}+ object and returns a +{response}+.
[id="{upid}-{api}-request"]
==== Get Data Frame Transform Stats Request
A +{request}+ requires a data frame transform id or the special wildcard `_all`
to get the statistics for all {dataframe-transform}s
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Constructing a new GET Stats request referencing an existing {dataframe-transform}
include::../execution.asciidoc[]
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ contains the requested {dataframe-transform} statistics.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The response contains a list of `DataFrameTransformStateAndStats` objects
<2> The running state of the transform e.g `started`
<3> The transform progress statistics recording the number of documents indexed etc

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

@ -554,12 +554,14 @@ include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
The Java High Level REST Client supports the following Data Frame APIs:
* <<{upid}-get-data-frame-transform-stats>>
* <<{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/get_data_frame_stats.asciidoc[]
include::dataframe/put_data_frame.asciidoc[]
include::dataframe/delete_data_frame.asciidoc[]
include::dataframe/preview_data_frame.asciidoc[]