[DOCS] Adds unattended setting to transforms API docs. (#89335)

This commit is contained in:
István Zoltán Szabó 2022-08-29 11:46:52 +02:00 committed by GitHub
parent 06226397fb
commit accf737145
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 0 deletions

View file

@ -1059,6 +1059,13 @@ The minimum value is `0` and the maximum is `100`.
The default value is the cluster-level setting `num_transform_failure_retries`.
end::transform-settings-num-failure-retries[]
tag::transform-settings-unattended[]
If `true`, the {transform} runs in unattended mode. In unattended mode, the
{transform} retries indefinitely in case of an error which means the {transform}
never fails. Setting the number of retries other than infinite fails in
validation. Defaults to `false`.
end::transform-settings-unattended[]
tag::transform-sort[]
Specifies the date field that is used to identify the latest documents.
end::transform-sort[]

View file

@ -251,6 +251,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-ded
`max_page_search_size`:::
(Optional, integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
`unattended`:::
(Optional, boolean)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
====
//End settings

View file

@ -218,6 +218,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max
`num_failure_retries`:::
(Optional, integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries]
`unattended`:::
(Optional, boolean)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
====
//End settings

View file

@ -160,6 +160,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max
`num_failure_retries`:::
(Optional, integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries]
`unattended`:::
(Optional, boolean)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
====
//End settings