[DOCS] Adds more validation details for data frame transforms (#44714)
This commit is contained in:
parent
5878bde8dc
commit
ed8f75c990
|
@ -31,6 +31,12 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
|
||||||
[[put-data-frame-transform-desc]]
|
[[put-data-frame-transform-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
|
When the {dataframe-transform} is created, a series of validations occur to
|
||||||
|
ensure its success. For example, there is a check for the existence of the
|
||||||
|
source indices and a check that the destination index is not part of the source
|
||||||
|
index pattern. You can use the `defer_validation` parameter to skip these
|
||||||
|
checks.
|
||||||
|
|
||||||
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
||||||
Do not put a {dataframe-transform} directly into any
|
Do not put a {dataframe-transform} directly into any
|
||||||
`.data-frame-internal*` indices using the Elasticsearch index API.
|
`.data-frame-internal*` indices using the Elasticsearch index API.
|
||||||
|
@ -52,10 +58,10 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
||||||
(Optional, boolean) When `true`, deferrable validations are not run. This
|
(Optional, boolean) When `true`, deferrable validations are not run. This
|
||||||
behavior may be desired if the source index does not exist until after the
|
behavior may be desired if the source index does not exist until after the
|
||||||
{dataframe-transform} is created. Deferred validations are always run when the
|
{dataframe-transform} is created. Deferred validations are always run when the
|
||||||
{dataframe-transform} is started, with the exception of privilege checks. If the
|
{dataframe-transform} is started, with the exception of privilege checks. If
|
||||||
user who created the transform does not have the required privileges on the
|
the user who created the transform does not have the required privileges on
|
||||||
source and destination indices, the transform starts but then fails when it
|
the source and destination indices, the transform starts but then fails when
|
||||||
attempts the unauthorized operation. The default value is `false`.
|
it attempts the unauthorized operation. The default value is `false`.
|
||||||
|
|
||||||
[[put-data-frame-transform-request-body]]
|
[[put-data-frame-transform-request-body]]
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
|
@ -27,6 +27,16 @@ have `view_index_metadata` privileges on the source index for the
|
||||||
{stack-ov}/security-privileges.html[Security privileges] and
|
{stack-ov}/security-privileges.html[Security privileges] and
|
||||||
{stack-ov}/built-in-roles.html[Built-in roles].
|
{stack-ov}/built-in-roles.html[Built-in roles].
|
||||||
|
|
||||||
|
[[start-data-frame-transform-desc]]
|
||||||
|
==== {api-description-title}
|
||||||
|
|
||||||
|
When a {dataframe-transform} starts, a series of validations occur to ensure its
|
||||||
|
success. If you deferred validation when you created the {dataframe-transform},
|
||||||
|
they occur when you start the transform--with the exception of privilege checks.
|
||||||
|
If the user who created the transform does not have the required privileges on
|
||||||
|
the source and destination indices, the transform starts but then fails when
|
||||||
|
it attempts the unauthorized operation.
|
||||||
|
|
||||||
[[start-data-frame-transform-path-parms]]
|
[[start-data-frame-transform-path-parms]]
|
||||||
==== {api-path-parms-title}
|
==== {api-path-parms-title}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue