Skip to content

Commit e679984

Browse files
committed
[DOCS] Adds placeholder for start and stop data frame transform APIs (#40278)
1 parent caa0129 commit e679984

File tree

6 files changed

+110
-4
lines changed

6 files changed

+110
-4
lines changed

docs/reference/data-frames/apis/index.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
1111
* <<put-data-frame-transform,Create {dataframe-transforms}>>,
1212
<<delete-data-frame-transform,delete {dataframe-transforms}>>
13-
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
1413
* <<get-data-frame-transform,Get {dataframe-transform} info>>,
1514
<<get-data-frame-transform-stats,Get {dataframe-transform} statistics>>
15+
* <<start-data-frame-transform,Start {dataframe-transforms}>>, <<stop-data-frame-transform,Stop {dataframe-transforms}>>
1616

1717
//CREATE
1818
include::put-transform.asciidoc[]
@@ -22,4 +22,8 @@ include::delete-transform.asciidoc[]
2222
include::get-transform.asciidoc[]
2323
include::get-transform-stats.asciidoc[]
2424
//PREVIEW
25-
include::preview-data-frame-transform.asciidoc[]
25+
include::preview-transform.asciidoc[]
26+
//START
27+
include::start-transform.asciidoc[]
28+
//STOP
29+
include::stop-transform.asciidoc[]
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[role="xpack"]
2+
[testenv="basic"]
3+
[[start-data-frame-transform]]
4+
=== Start {dataframe-transforms} API
5+
++++
6+
<titleabbrev>Start {dataframe-transforms}</titleabbrev>
7+
++++
8+
9+
Starts one or more {dataframe-transforms}.
10+
11+
==== Request
12+
13+
`POST _data_frame/transforms/<data_frame_transform_id>/_start`
14+
15+
//==== Description
16+
17+
==== Path Parameters
18+
19+
`data_frame_transform_id` (required)::
20+
(string) Identifier for the {dataframe-transform}. This identifier can contain
21+
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
22+
must start and end with alphanumeric characters.
23+
24+
//==== Request Body
25+
//==== Authorization
26+
27+
==== Examples
28+
29+
The following example starts the `ecommerce_transform` {dataframe-transform}:
30+
31+
[source,js]
32+
--------------------------------------------------
33+
POST _data_frame/transforms/ecommerce_transform/_start
34+
--------------------------------------------------
35+
// CONSOLE
36+
// TEST[skip:set up kibana samples]
37+
38+
When the {dataframe-transform} starts, you receive the following results:
39+
[source,js]
40+
----
41+
{
42+
"started" : true
43+
}
44+
----
45+
// TESTRESPONSE
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[role="xpack"]
2+
[testenv="basic"]
3+
[[stop-data-frame-transform]]
4+
=== Stop {dataframe-transforms} API
5+
++++
6+
<titleabbrev>Stop {dataframe-transforms}</titleabbrev>
7+
++++
8+
9+
Stops one or more {dataframe-transforms}.
10+
11+
==== Request
12+
13+
`POST _data_frame/transforms/<data_frame_transform_id>/_stop`
14+
15+
//==== Description
16+
17+
==== Path Parameters
18+
19+
`data_frame_transform_id` (required)::
20+
(string) Identifier for the {dataframe-transform}. This identifier can contain
21+
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
22+
must start and end with alphanumeric characters.
23+
24+
==== Query Parameters
25+
26+
`wait_for_completion`::
27+
(boolean) If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults to `false`.
28+
29+
`timeout`::
30+
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
31+
the specified duration while waiting for the job to stop. If more than
32+
`timeout` time has passed, the API throws a timeout exception. Even if a
33+
timeout exception is thrown, the stop request is still processing and
34+
eventually moves the job to `STOPPED`. The timeout simply means the API call itself timed out while waiting for the status change. Defaults to `30s`
35+
36+
//==== Request Body
37+
//==== Authorization
38+
39+
==== Examples
40+
41+
The following example stops the `ecommerce_transform` {dataframe-transform}:
42+
43+
[source,js]
44+
--------------------------------------------------
45+
POST _data_frame/transforms/ecommerce_transform/_stop
46+
--------------------------------------------------
47+
// CONSOLE
48+
// TEST[skip:set up kibana samples]
49+
50+
When the {dataframe-transform} stops, you receive the following results:
51+
[source,js]
52+
----
53+
{
54+
"stopped" : true
55+
}
56+
----
57+
// TESTRESPONSE

x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"data_frame.start_data_frame_transform": {
3-
"documentation": "TODO",
3+
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html",
44
"methods": [ "POST" ],
55
"url": {
66
"path": "/_data_frame/transforms/{transform_id}/_start",

x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"data_frame.stop_data_frame_transform": {
3-
"documentation": "TODO",
3+
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html",
44
"methods": [ "POST" ],
55
"url": {
66
"path": "/_data_frame/transforms/{transform_id}/_stop",

0 commit comments

Comments
 (0)