Skip to content

[DOCS] Adds placeholder for start and stop data frame transform APIs #40278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/reference/data-frames/apis/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
* <<put-data-frame-transform,Create {dataframe-transforms}>>,
<<delete-data-frame-transform,delete {dataframe-transforms}>>
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
* <<get-data-frame-transform,Get {dataframe-transform} info>>,
<<get-data-frame-transform-stats,Get {dataframe-transform} statistics>>
* <<start-data-frame-transform,Start {dataframe-transforms}>>, <<stop-data-frame-transform,Stop {dataframe-transforms}>>

//CREATE
include::put-transform.asciidoc[]
Expand All @@ -22,4 +22,8 @@ include::delete-transform.asciidoc[]
include::get-transform.asciidoc[]
include::get-transform-stats.asciidoc[]
//PREVIEW
include::preview-data-frame-transform.asciidoc[]
include::preview-transform.asciidoc[]
//START
include::start-transform.asciidoc[]
//STOP
include::stop-transform.asciidoc[]
45 changes: 45 additions & 0 deletions docs/reference/data-frames/apis/start-transform.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[role="xpack"]
[testenv="basic"]
[[start-data-frame-transform]]
=== Start {dataframe-transforms} API
++++
<titleabbrev>Start {dataframe-transforms}</titleabbrev>
++++

Starts one or more {dataframe-transforms}.

==== Request

`POST _data_frame/transforms/<data_frame_transform_id>/_start`

//==== Description

==== Path Parameters

`data_frame_transform_id` (required)::
(string) Identifier for the {dataframe-transform}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.

//==== Request Body
//==== Authorization

==== Examples

The following example starts the `ecommerce_transform` {dataframe-transform}:

[source,js]
--------------------------------------------------
POST _data_frame/transforms/ecommerce_transform/_start
--------------------------------------------------
// CONSOLE
// TEST[skip:set up kibana samples]

When the {dataframe-transform} starts, you receive the following results:
[source,js]
----
{
"started" : true
}
----
// TESTRESPONSE
57 changes: 57 additions & 0 deletions docs/reference/data-frames/apis/stop-transform.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[role="xpack"]
[testenv="basic"]
[[stop-data-frame-transform]]
=== Stop {dataframe-transforms} API
++++
<titleabbrev>Stop {dataframe-transforms}</titleabbrev>
++++

Stops one or more {dataframe-transforms}.

==== Request

`POST _data_frame/transforms/<data_frame_transform_id>/_stop`

//==== Description

==== Path Parameters

`data_frame_transform_id` (required)::
(string) Identifier for the {dataframe-transform}. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
must start and end with alphanumeric characters.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add query parameters wait_for_completion and timeout? Both work the very same way as documented for stop rollup,

==== Query Parameters

`wait_for_completion`::
(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`.

`timeout`::
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
the specified duration while waiting for the job to stop. If more than
`timeout` time has passed, the API throws a timeout exception. Even if a
timeout exception is thrown, the stop request is still processing and
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`

//==== Request Body
//==== Authorization

==== Examples

The following example stops the `ecommerce_transform` {dataframe-transform}:

[source,js]
--------------------------------------------------
POST _data_frame/transforms/ecommerce_transform/_stop
--------------------------------------------------
// CONSOLE
// TEST[skip:set up kibana samples]

When the {dataframe-transform} stops, you receive the following results:
[source,js]
----
{
"stopped" : true
}
----
// TESTRESPONSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"data_frame.start_data_frame_transform": {
"documentation": "TODO",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html",
"methods": [ "POST" ],
"url": {
"path": "/_data_frame/transforms/{transform_id}/_start",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"data_frame.stop_data_frame_transform": {
"documentation": "TODO",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html",
"methods": [ "POST" ],
"url": {
"path": "/_data_frame/transforms/{transform_id}/_stop",
Expand Down