-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3d8f7fb
[DOCS] Adds placeholder for start and stop data frame transform APIs
lcawl aa5c413
Adds URL to REST API spec
lcawl f2d7763
[DOCS] Adds query parameters for stop API
lcawl 1242bb8
[DOCS] Renames preview transform file
lcawl dbe9076
Merge branch 'master' into start-transform
lcawl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
==== 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 |
2 changes: 1 addition & 1 deletion
2
...ck/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
andtimeout
? Both work the very same way as documented for stop rollup,