[DOCS] Adds placeholder for get data frame transform APIs (#40283)

This commit is contained in:
Lisa Cawley 2019-03-21 07:45:17 -07:00 committed by lcawl
parent 2f80b7304f
commit ff2bcc9d11
5 changed files with 197 additions and 2 deletions

View File

@ -0,0 +1,88 @@
[role="xpack"]
[testenv="basic"]
[[get-data-frame-transform-stats]]
=== Get {dataframe-transform} statistics API
++++
<titleabbrev>Get {dataframe-transform} statistics</titleabbrev>
++++
Retrieves usage information for {dataframe-transforms}.
==== Request
`GET _data_frame/transforms/<data_frame_transform_id>/_stats`
`GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>/_stats` +
`GET _data_frame/transforms/_stats` +
`GET _data_frame/transforms/_all/_stats` +
`GET _data_frame/transforms/*/_stats` +
//===== Description
==== Path Parameters
`data_frame_transform_id`::
(string) Identifier for the {dataframe-transform}. It can be a
{dataframe-transform} identifier or a wildcard expression. If you do not
specify one of these options, the API returns information for all
{dataframe-transforms}.
==== Results
The API returns the following information:
`transforms`::
(array) An array of statistics objects for {dataframe-transforms}.
//==== Authorization
==== Examples
The following example gets usage information for the `ecommerce_transform`
{dataframe-transform}:
[source,js]
--------------------------------------------------
GET _data_frame/transforms/ecommerce_transform/_stats
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]
The API returns the following results:
[source,js]
----
{
"count" : 1,
"transforms" : [
{
"id" : "ecommerce_transform",
"state" : {
"transform_state" : "started",
"current_position" : {
"customer_id" : "9"
},
"generation" : 1
},
"stats" : {
"pages_processed" : 0,
"documents_processed" : 0,
"documents_indexed" : 0,
"trigger_count" : 0,
"index_time_in_ms" : 0,
"index_total" : 0,
"index_failures" : 0,
"search_time_in_ms" : 0,
"search_total" : 0,
"search_failures" : 0
}
}
]
}
----
// TESTRESPONSE

View File

@ -0,0 +1,102 @@
[role="xpack"]
[testenv="basic"]
[[get-data-frame-transform]]
=== Get {dataframe-transforms} API
++++
<titleabbrev>Get {dataframe-transforms}</titleabbrev>
++++
Retrieves configuration information for {dataframe-transforms}.
==== Request
`GET _data_frame/transforms/<data_frame_transform_id>` +
`GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>` +
`GET _data_frame/transforms/` +
`GET _data_frame/transforms/_all` +
`GET _data_frame/transforms/*`
//===== Description
==== Path Parameters
`data_frame_transform_id`::
(string) Identifier for the {dataframe-transform}. It can be a
{dataframe-transform} identifier or a wildcard expression. If you do not
specify one of these options, the API returns information for all
{dataframe-transforms}.
////
==== Request Body
`page`::
`from`:::
(integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.
`size`:::
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
The default value is `100`.
////
==== Results
The API returns the following information:
`transforms`::
(array) An array of transform resources.
//==== Authorization
==== Examples
The following example gets configuration information for the
`ecommerce_transform` {dataframe-transform}:
[source,js]
--------------------------------------------------
GET _data_frame/transforms/ecommerce_transform
--------------------------------------------------
// CONSOLE
// TEST[skip:setup kibana sample data]
The API returns the following results:
[source,js]
----
{
"count" : 1,
"transforms" : [
{
"id" : "ecommerce_transform",
"source" : "kibana_sample_data_ecommerce",
"dest" : "kibana_sample_data_ecommerce_transform",
"query" : {
"match_all" : { }
},
"pivot" : {
"group_by" : {
"customer_id" : {
"terms" : {
"field" : "customer_id"
}
}
},
"aggregations" : {
"max_price" : {
"max" : {
"field" : "taxful_total_price"
}
}
}
}
}
]
}
----
// TESTRESPONSE

View File

@ -7,7 +7,12 @@
[[data-frame-transform-apis]]
=== {dataframe-transforms-cap}
* <<get-data-frame-transform,Get {dataframe-transform} info>>,
<<get-data-frame-transform-stats,Get {dataframe-transform} statistics>>
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
//GET
include::get-transform.asciidoc[]
include::get-transform-stats.asciidoc[]
//PREVIEW
include::preview-data-frame-transform.asciidoc[]

View File

@ -1,6 +1,6 @@
{
"data_frame.get_data_frame_transform": {
"documentation": "TODO",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html",
"methods": [ "GET" ],
"url": {
"path": "/_data_frame/transforms/{transform_id}",

View File

@ -1,6 +1,6 @@
{
"data_frame.get_data_frame_transform_stats": {
"documentation": "TODO",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html",
"methods": [ "GET" ],
"url": {
"path": "/_data_frame/transforms/{transform_id}/_stats",