[DOCS] Updates data frame APIs to use API template (#43610)
This commit is contained in:
Lisa Cawley
lcawl
parent
d05593c3ad
commit
ad84059db6
|
|
@ -12,21 +12,15 @@ beta[]
|
|||
|
||||
Deletes an existing {dataframe-transform}.
|
||||
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[delete-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`DELETE _data_frame/transforms/<data_frame_transform_id>`
|
||||
|
||||
==== Description
|
||||
|
||||
NOTE: Before you can delete the {dataframe-transform}, you must stop it.
|
||||
|
||||
==== Path Parameters
|
||||
|
||||
`data_frame_transform_id` (required)::
|
||||
(string) Identifier for the {dataframe-transform}.
|
||||
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[delete-data-frame-transform-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -34,9 +28,22 @@ If the {es} {security-features} are enabled, you must have
|
|||
see {stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
[discrete]
|
||||
[[delete-data-frame-transform-desc]]
|
||||
==== {api-description-title}
|
||||
|
||||
The following example deletes the `ecommerce_transform` {dataframe-transform}:
|
||||
NOTE: Before you can delete the {dataframe-transform}, you must stop it.
|
||||
|
||||
[discrete]
|
||||
[[delete-data-frame-transform-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<data_frame_transform_id>` (Required)::
|
||||
(string) Identifier for the {dataframe-transform}.
|
||||
|
||||
[discrete]
|
||||
[[delete-data-frame-transform-examples]]
|
||||
==== {api-example-title}
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -12,8 +12,9 @@ beta[]
|
|||
|
||||
Retrieves usage information for {dataframe-transforms}.
|
||||
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[get-data-frame-transform-stats-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
|
||||
`GET _data_frame/transforms/<data_frame_transform_id>/_stats`
|
||||
|
|
@ -26,38 +27,9 @@ Retrieves usage information for {dataframe-transforms}.
|
|||
|
||||
`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}.
|
||||
|
||||
==== Query Parameters
|
||||
|
||||
`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`.
|
||||
|
||||
`allow_no_match`::
|
||||
(boolean) Whether to ignore if a wildcard expression matches no data frame transforms.
|
||||
This includes `_all` string or when no transforms have been specified. The default is `true`.
|
||||
|
||||
==== Results
|
||||
|
||||
The API returns the following information:
|
||||
|
||||
`transforms`::
|
||||
(array) An array of statistics objects for {dataframe-transforms}, which are
|
||||
sorted by the `id` value in ascending order.
|
||||
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[get-data-frame-transform-stats-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -65,6 +37,47 @@ If the {es} {security-features} are enabled, you must have
|
|||
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-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<data_frame_transform_id>` (Optional)::
|
||||
(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}.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-stats-query-parms]]
|
||||
==== {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`.
|
||||
|
||||
`from` (Optional)::
|
||||
(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`.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-stats-response]]
|
||||
==== {api-response-body-title}
|
||||
|
||||
`transforms`::
|
||||
(array) An array of statistics objects for {dataframe-transforms}, which are
|
||||
sorted by the `id` value in ascending order.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-stats-example]]
|
||||
==== Examples
|
||||
|
||||
The following example skips for the first five {dataframe-transforms} and
|
||||
|
|
|
|||
|
|
@ -12,8 +12,9 @@ beta[]
|
|||
|
||||
Retrieves configuration information for {dataframe-transforms}.
|
||||
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[get-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`GET _data_frame/transforms/<data_frame_transform_id>` +
|
||||
|
||||
|
|
@ -25,38 +26,9 @@ Retrieves configuration information for {dataframe-transforms}.
|
|||
|
||||
`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}.
|
||||
|
||||
==== Query Parameters
|
||||
|
||||
`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`.
|
||||
|
||||
`allow_no_match`::
|
||||
(boolean) Whether to ignore if a wildcard expression matches no data frame transforms.
|
||||
This includes `_all` string or when no transforms have been specified. The default is `true`.
|
||||
|
||||
==== Results
|
||||
|
||||
The API returns the following information:
|
||||
|
||||
`transforms`::
|
||||
(array) An array of transform resources, which are sorted by the `id` value in
|
||||
ascending order.
|
||||
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[get-data-frame-transform-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -64,7 +36,44 @@ If the {es} {security-features} are enabled, you must have
|
|||
see {stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
[discrete]
|
||||
[[get-data-frame-transform-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<data_frame_transform_id>` (Optional)::
|
||||
(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}.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-query-parms]]
|
||||
==== {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`.
|
||||
|
||||
`from` (Optional)::
|
||||
(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`.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-response]]
|
||||
==== {api-response-body-title}
|
||||
|
||||
`transforms`::
|
||||
(array) An array of transform resources, which are sorted by the `id` value in
|
||||
ascending order.
|
||||
|
||||
[discrete]
|
||||
[[get-data-frame-transform-example]]
|
||||
==== {api-example-title}
|
||||
|
||||
The following example retrieves information about a maximum of ten transforms:
|
||||
|
||||
|
|
|
|||
|
|
@ -12,22 +12,15 @@ beta[]
|
|||
|
||||
Previews a {dataframe-transform}.
|
||||
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[preview-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`POST _data_frame/transforms/_preview`
|
||||
|
||||
//==== Description
|
||||
//==== Path Parameters
|
||||
|
||||
==== Request Body
|
||||
|
||||
`source`:: The source index or index pattern.
|
||||
|
||||
`pivot`:: Defines the pivot function `group by` fields and the aggregation to
|
||||
reduce the data.
|
||||
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[preview-data-frame-transform-prereq]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -37,10 +30,19 @@ If the {es} {security-features} are enabled, you must have
|
|||
{stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
[discrete]
|
||||
[[preview-data-frame-transform-request-body]]
|
||||
==== {api-request-body-title}
|
||||
|
||||
The following example obtains a preview of a {dataframe-transform} on the {kib}
|
||||
eCommerce sample data:
|
||||
`source` (Required)::
|
||||
(object) The source index or index pattern.
|
||||
|
||||
`pivot` (Required)::
|
||||
(object) Defines the pivot function `group by` fields and the aggregation to
|
||||
reduce the data. See <<data-frame-transform-pivot>>.
|
||||
|
||||
[discrete]
|
||||
==== {api-example-title}
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -12,42 +12,15 @@ beta[]
|
|||
|
||||
Instantiates a {dataframe-transform}.
|
||||
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[put-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`PUT _data_frame/transforms/<data_frame_transform_id>`
|
||||
|
||||
===== Description
|
||||
|
||||
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
||||
Do not put a {dataframe-transform} directly into any
|
||||
`.data-frame-internal*` indices using the Elasticsearch index API.
|
||||
If {es} {security-features} are enabled, do not give users any
|
||||
privileges on `.data-frame-internal*` indices.
|
||||
|
||||
==== 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
|
||||
|
||||
`source` (required):: (object) The source configuration, consisting of `index` and optionally
|
||||
a `query`.
|
||||
|
||||
`dest` (required):: (object) The destination configuration, consisting of `index` and optionally a
|
||||
`pipeline` id.
|
||||
|
||||
`pivot`:: (object) Defines the pivot function `group by` fields and the aggregation to
|
||||
reduce the data. See <<data-frame-transform-pivot, data frame transform pivot objects>>.
|
||||
|
||||
`description`:: Optional free text description of the data frame transform
|
||||
|
||||
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[put-data-frame-transform-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -57,10 +30,48 @@ have `read` and `view_index_metadata` privileges on the source index and `read`,
|
|||
information, see {stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example creates a {dataframe-transform} for the {kib} eCommerce
|
||||
sample data:
|
||||
[discrete]
|
||||
[[put-data-frame-transform-desc]]
|
||||
===== {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
|
||||
`.data-frame-internal*` indices using the Elasticsearch index API.
|
||||
If {es} {security-features} are enabled, do not give users any
|
||||
privileges on `.data-frame-internal*` indices.
|
||||
|
||||
[discrete]
|
||||
[[put-data-frame-transform-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<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.
|
||||
|
||||
[discrete]
|
||||
[[put-data-frame-transform-request-body]]
|
||||
==== {api-request-body-title}
|
||||
|
||||
`description` (Optional)::
|
||||
(string) Free text description of the {dataframe-transform}.
|
||||
|
||||
`dest` (Required)::
|
||||
(object) The destination configuration, which consists of `index` and
|
||||
optionally a `pipeline` id.
|
||||
|
||||
`pivot` (Optional)::
|
||||
(object) Defines the pivot function `group by` fields and the aggregation to
|
||||
reduce the data. See <<data-frame-transform-pivot>>.
|
||||
|
||||
`source` (Required)::
|
||||
(object) The source configuration, which consists of `index` and optionally
|
||||
a `query`.
|
||||
|
||||
[discrete]
|
||||
[[put-data-frame-transform-example]]
|
||||
==== {api-example-title}
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -12,21 +12,15 @@ beta[]
|
|||
|
||||
Starts one or more {dataframe-transforms}.
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[start-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`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
|
||||
[discrete]
|
||||
[[start-data-frame-transform-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`manage_data_frame_transforms` cluster privileges to use this API. You must also
|
||||
|
|
@ -35,9 +29,18 @@ have `view_index_metadata` privileges on the source index for the
|
|||
{stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
[discrete]
|
||||
[[start-data-frame-transform-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
The following example starts the `ecommerce_transform` {dataframe-transform}:
|
||||
`<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.
|
||||
|
||||
[discrete]
|
||||
[[start-data-frame-transform-example]]
|
||||
==== {api-example-title}
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -12,7 +12,9 @@ beta[]
|
|||
|
||||
Stops one or more {dataframe-transforms}.
|
||||
|
||||
==== Request
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`POST _data_frame/transforms/<data_frame_transform_id>/_stop` +
|
||||
|
||||
|
|
@ -20,38 +22,9 @@ Stops one or more {dataframe-transforms}.
|
|||
|
||||
`POST _data_frame/transforms/_all/_stop`
|
||||
|
||||
|
||||
==== Description
|
||||
You can stop multiple {dataframe-transforms} in a single API request by using a
|
||||
comma-separated list of {dataframe-transforms} or a wildcard expression.
|
||||
All {dataframe-transforms} can be stopped by using `_all` or `*` as the `<data_frame_transform_id>`.
|
||||
|
||||
==== 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 transform 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 transform to `STOPPED`. The timeout simply means the API
|
||||
call itself timed out while waiting for the status change. Defaults to `30s`
|
||||
|
||||
`allow_no_match`::
|
||||
(boolean) Whether to ignore if a wildcard expression matches no data frame transforms.
|
||||
This includes `_all` string or when no transforms have been specified. The default is `true`.
|
||||
|
||||
//==== Request Body
|
||||
==== Authorization
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-prereq]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have
|
||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||
|
|
@ -59,9 +32,49 @@ If the {es} {security-features} are enabled, you must have
|
|||
see {stack-ov}/security-privileges.html[Security privileges] and
|
||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||
|
||||
==== Examples
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-desc]]
|
||||
==== {api-description-title}
|
||||
|
||||
The following example stops the `ecommerce_transform` {dataframe-transform}:
|
||||
You can stop multiple {dataframe-transforms} in a single API request by using a
|
||||
comma-separated list of {dataframe-transforms} or a wildcard expression.
|
||||
All {dataframe-transforms} can be stopped by using `_all` or `*` as the
|
||||
`<data_frame_transform_id>`.
|
||||
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-path-parms]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<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.
|
||||
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-query-parms]]
|
||||
==== {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`.
|
||||
|
||||
`timeout` (Optional)::
|
||||
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
|
||||
the specified duration while waiting for the transform 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 transform to `STOPPED`. The timeout simply means the API
|
||||
call itself timed out while waiting for the status change. Defaults to `30s`
|
||||
|
||||
`wait_for_completion` (Optional)::
|
||||
(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`.
|
||||
|
||||
[discrete]
|
||||
[[stop-data-frame-transform-example]]
|
||||
==== {api-example-title}
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
Loading…
Reference in New Issue