Skip to content
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
2 changes: 1 addition & 1 deletion docs/reference/data-frames/apis/delete-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Deletes an existing {dataframe-transform}.
[[delete-data-frame-transform-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. For more information,
see {stack-ov}/security-privileges.html[Security privileges] and
Expand Down
44 changes: 33 additions & 11 deletions docs/reference/data-frames/apis/get-transform-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,21 @@ Retrieves usage information for {dataframe-transforms}.
[[get-data-frame-transform-stats-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_user` role has these privileges. For more information,
see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].

//[discrete]
//[[get-data-frame-transform-stats-desc]]
//===== {api-description-title}
[discrete]
[[get-data-frame-transform-stats-desc]]
==== {api-description-title}

You can get statistics for multiple {dataframe-transforms} in a single API
request by using a comma-separated list of identifiers or a wildcard expression.
You can get statistics for all {dataframe-transforms} by using `_all`, by
specifying `*` as the `<data_frame_transform_id>`, or by omitting the
`<data_frame_transform_id>`.

[discrete]
[[get-data-frame-transform-stats-path-parms]]
Expand All @@ -56,17 +62,26 @@ see {stack-ov}/security-privileges.html[Security privileges] and
==== {api-query-parms-title}

`allow_no_match` (Optional)::
(boolean) Whether to ignore if a wildcard expression matches no
{dataframe-transforms}. This includes `_all` string or when no transforms have
been specified. The default is `true`.
(boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.

The default value is `true`, which returns an empty `transforms` array when
there are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--

`from` (Optional)::
(integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.
(integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.

`size` (Optional)::
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
The default value is `100`.
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
The default value is `100`.

[discrete]
[[get-data-frame-transform-stats-response]]
Expand All @@ -75,6 +90,13 @@ see {stack-ov}/security-privileges.html[Security privileges] and
`transforms`::
(array) An array of statistics objects for {dataframe-transforms}, which are
sorted by the `id` value in ascending order.

[[get-data-frame-transform-stats-response-codes]]
==== {api-response-codes-title}

`404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.

[discrete]
[[get-data-frame-transform-stats-example]]
Expand Down
42 changes: 34 additions & 8 deletions docs/reference/data-frames/apis/get-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,22 @@ Retrieves configuration information for {dataframe-transforms}.
[[get-data-frame-transform-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_user` role has these privileges. For more information,
see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].

[discrete]
[[get-data-frame-transform-desc]]
==== {api-description-title}

You can get information for multiple {dataframe-transforms} in a single API
request by using a comma-separated list of identifiers or a wildcard expression.
You can get information for all {dataframe-transforms} by using `_all`, by
specifying `*` as the `<data_frame_transform_id>`, or by omitting the
`<data_frame_transform_id>`.

[discrete]
[[get-data-frame-transform-path-parms]]
==== {api-path-parms-title}
Expand All @@ -51,17 +61,26 @@ see {stack-ov}/security-privileges.html[Security privileges] and
==== {api-query-parms-title}

`allow_no_match` (Optional)::
(boolean) Whether to ignore if a wildcard expression matches no
{dataframe-transforms}. This includes `_all` string or when no transforms have
been specified. The default is `true`.
(boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.

The default value is `true`, which returns an empty `transforms` array when
there are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--

`from` (Optional)::
(integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.
(integer) Skips the specified number of {dataframe-transforms}. The
default value is `0`.

`size` (Optional)::
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
The default value is `100`.
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
The default value is `100`.

[discrete]
[[get-data-frame-transform-response]]
Expand All @@ -70,6 +89,13 @@ see {stack-ov}/security-privileges.html[Security privileges] and
`transforms`::
(array) An array of transform resources, which are sorted by the `id` value in
ascending order.

[[get-data-frame-transform-response-codes]]
==== {api-response-codes-title}

`404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.

[discrete]
[[get-data-frame-transform-example]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data-frames/apis/preview-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Previews a {dataframe-transform}.
[[preview-data-frame-transform-prereq]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. You must also have
`read` and `view_index_metadata` privileges on the source index for the
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/data-frames/apis/put-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,17 @@ Instantiates a {dataframe-transform}.
[[put-data-frame-transform-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. You must also
have `read` and `view_index_metadata` privileges on the source index and `read`,
`create_index`, and `index` privileges on the destination index. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].


[discrete]
[[put-data-frame-transform-desc]]
===== {api-description-title}
==== {api-description-title}

IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
Do not put a {dataframe-transform} directly into any
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data-frames/apis/start-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Starts one or more {dataframe-transforms}.
[[start-data-frame-transform-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. You must also
have `view_index_metadata` privileges on the source index for the
{dataframe-transform}. For more information, see
Expand Down
30 changes: 26 additions & 4 deletions docs/reference/data-frames/apis/stop-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Stops one or more {dataframe-transforms}.
[[stop-data-frame-transform-prereq]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. For more information,
see {stack-ov}/security-privileges.html[Security privileges] and
Expand Down Expand Up @@ -55,9 +55,23 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
==== {api-query-parms-title}

`allow_no_match` (Optional)::
(boolean) Whether to ignore if a wildcard expression matches no
{dataframe-transforms}. This includes `_all` string or when no transforms have
been specified. The default is `true`.
(boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {dataframe-transforms} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.

The default value is `true`, which returns a successful acknowledgement message
when there are no matches. When there are only partial matches, the API stops
the appropriate {dataframe-transforms}. For example, if the request contains
`test-id1*,test-id2*` as the identifiers and there are no {dataframe-transforms}
that match `test-id2*`, the API nonetheless stops the {dataframe-transforms}
that match `test-id1*`.

If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--

`timeout` (Optional)::
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
Expand All @@ -72,6 +86,14 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
completely stops. If set to `false`, the API returns immediately and the
indexer will be stopped asynchronously in the background. Defaults to `false`.

[discrete]
[[stop-data-frame-transform-response-codes]]
==== {api-response-codes-title}

`404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.

[discrete]
[[stop-data-frame-transform-example]]
==== {api-examples-title}
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/ml/apis/close-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ A job can be opened and closed multiple times throughout its lifecycle.
A closed job cannot receive data or perform analysis
operations, but you can still explore and navigate results.

[discrete]
[[ml-close-job-request]]
==== {api-request-title}

Expand Down Expand Up @@ -55,7 +54,6 @@ after the close job API returns. The `force` query parameter should only be use
situations where the job has already failed, or where you are not interested in
results the job might have recently produced or might produce in the future.

[discrete]
[[ml-close-job-path-parms]]
==== {api-path-parms-title}

Expand Down