mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 15:17:30 -04:00
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
This commit is contained in:
Liam Thompson
GitHub
parent
9b91d9c072
commit
33a71e3289
344 changed files with 2331 additions and 2328 deletions
|
|
@ -26,7 +26,7 @@ in the `transform_admin` built-in role.
|
|||
|
||||
`<transform_id>`::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
|
||||
[[delete-transform-query-parms]]
|
||||
== {api-query-parms-title}
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ specifying `*` as the `<transform_id>`, or by omitting the
|
|||
|
||||
`<transform_id>`::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
||||
|
||||
|
||||
[[get-transform-stats-query-parms]]
|
||||
|
|
@ -57,15 +57,15 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
|||
|
||||
`allow_no_match`::
|
||||
(Optional, Boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
||||
|
||||
`from`::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
|
||||
|
||||
`size`::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
|
||||
|
||||
[role="child_attributes"]
|
||||
[[get-transform-stats-response]]
|
||||
|
|
@ -84,7 +84,7 @@ informational; you cannot update their values.
|
|||
====
|
||||
`changes_last_detected_at`:::
|
||||
(date)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at]
|
||||
|
||||
//Begin checkpointing.last
|
||||
`last`:::
|
||||
|
|
@ -106,7 +106,7 @@ was created.
|
|||
|
||||
`last_search_time`:::
|
||||
(date)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time]
|
||||
|
||||
//Begin checkpointing.next
|
||||
`next`:::
|
||||
|
|
@ -191,7 +191,7 @@ that the {transform} is failing to keep up.
|
|||
|
||||
`id`::
|
||||
(string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
|
||||
//Begin node
|
||||
`node`::
|
||||
|
|
@ -221,11 +221,11 @@ example, `127.0.0.1:9300`.
|
|||
|
||||
`reason`::
|
||||
(string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
|
||||
|
||||
`state`::
|
||||
(string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform]
|
||||
|
||||
//Begin stats
|
||||
`stats`::
|
||||
|
|
@ -237,71 +237,71 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform]
|
|||
|
||||
`delete_time_in_ms`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms]
|
||||
|
||||
`documents_deleted`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform]
|
||||
|
||||
`documents_indexed`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed]
|
||||
|
||||
`documents_processed`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-processed]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-processed]
|
||||
|
||||
`exponential_avg_checkpoint_duration_ms`:::
|
||||
(double)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms]
|
||||
|
||||
`exponential_avg_documents_indexed`:::
|
||||
(double)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed]
|
||||
|
||||
`exponential_avg_documents_processed`:::
|
||||
(double)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]
|
||||
|
||||
`index_failures`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-failures]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-failures]
|
||||
|
||||
`index_time_in_ms`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms]
|
||||
|
||||
`index_total`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-total]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-total]
|
||||
|
||||
`pages_processed`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pages-processed]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pages-processed]
|
||||
|
||||
`processing_time_in_ms`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]
|
||||
|
||||
`processing_total`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-total]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-total]
|
||||
|
||||
`search_failures`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-failures]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-failures]
|
||||
|
||||
`search_time_in_ms`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms]
|
||||
|
||||
`search_total`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-total]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-total]
|
||||
|
||||
`trigger_count`:::
|
||||
(long)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=trigger-count]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=trigger-count]
|
||||
====
|
||||
//End stats
|
||||
|
||||
|
|
|
|||
|
|
@ -40,14 +40,14 @@ specifying `*` as the `<transform_id>`, or by omitting the `<transform_id>`.
|
|||
|
||||
`<transform_id>`::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
||||
|
||||
[[get-transform-query-parms]]
|
||||
== {api-query-parms-title}
|
||||
|
||||
`allow_no_match`::
|
||||
(Optional, Boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
||||
|
||||
`exclude_generated`::
|
||||
(Optional, Boolean)
|
||||
|
|
@ -57,11 +57,11 @@ and then added to another cluster. Default is false.
|
|||
|
||||
`from`::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
|
||||
|
||||
`size`::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -91,29 +91,29 @@ expires, the request fails and returns an error. Defaults to `30s`.
|
|||
//Begin dest
|
||||
`dest`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
+
|
||||
.Properties of `dest`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`index`:::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
|
||||
`pipeline`:::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
====
|
||||
//End dest
|
||||
|
||||
`frequency`::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
|
||||
//Begin latest
|
||||
`latest`::
|
||||
(Required^*^, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
||||
+
|
||||
.Properties of `latest`
|
||||
[%collapsible%open]
|
||||
|
|
@ -121,11 +121,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
|||
|
||||
`sort`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-sort]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-sort]
|
||||
|
||||
`unique_key`:::
|
||||
(Required, array of strings)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
||||
|
||||
====
|
||||
//End latest
|
||||
|
|
@ -133,43 +133,43 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
|||
//Begin pivot
|
||||
`pivot`::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot]
|
||||
+
|
||||
.Properties of `pivot`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`aggregations` or `aggs`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
|
||||
|
||||
`group_by`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]
|
||||
====
|
||||
//End pivot
|
||||
|
||||
//Begin retention policy
|
||||
`retention_policy`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
+
|
||||
.Properties of `retention_policy`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`time`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`field`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
|
||||
`max_age`:::
|
||||
(Required, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
=====
|
||||
====
|
||||
//End retention policy
|
||||
|
|
@ -177,29 +177,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti
|
|||
//Begin source
|
||||
`source`::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
+
|
||||
.Properties of `source`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`index`:::
|
||||
(Required, string or array)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
|
||||
`query`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
|
||||
`runtime_mappings`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms]
|
||||
====
|
||||
//End source
|
||||
|
||||
//Begin sync
|
||||
`sync`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
+
|
||||
.Properties of `sync`
|
||||
[%collapsible%open]
|
||||
|
|
@ -208,18 +208,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
|||
|
||||
`time`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`delay`::::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
|
||||
`field`::::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
=====
|
||||
//End sync.time
|
||||
====
|
||||
|
|
@ -228,29 +228,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
|||
//Begin settings
|
||||
`settings`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
+
|
||||
.Properties of `settings`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`align_checkpoints`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
`dates_as_epoch_millis`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
`deduce_mappings`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
`docs_per_second`:::
|
||||
(Optional, float)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
`max_page_search_size`:::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
|
||||
include::{es-ref-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]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
|
||||
====
|
||||
//End settings
|
||||
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
|
|||
//Begin dest
|
||||
`dest`::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
+
|
||||
.Properties of `dest`
|
||||
[%collapsible%open]
|
||||
|
|
@ -109,12 +109,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
|||
|
||||
`index`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
|
||||
//Begin aliases
|
||||
`aliases`:::
|
||||
(Optional, array of objects)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
||||
+
|
||||
.Properties of `aliases`
|
||||
[%collapsible%open]
|
||||
|
|
@ -122,29 +122,29 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
|||
|
||||
`alias`::::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias]
|
||||
|
||||
`move_on_creation`::::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation]
|
||||
|
||||
=====
|
||||
//End aliases
|
||||
|
||||
`pipeline`:::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
====
|
||||
//End dest
|
||||
|
||||
`frequency`::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
|
||||
//Begin latest
|
||||
`latest`::
|
||||
(Required^*^, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
||||
+
|
||||
.Properties of `latest`
|
||||
[%collapsible%open]
|
||||
|
|
@ -152,11 +152,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-latest]
|
|||
|
||||
`sort`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-sort]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-sort]
|
||||
|
||||
`unique_key`:::
|
||||
(Required, array of strings)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
||||
|
||||
====
|
||||
//End latest
|
||||
|
|
@ -164,13 +164,13 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-unique-key]
|
|||
//Begin _meta
|
||||
`_meta`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata]
|
||||
//End _meta
|
||||
|
||||
//Begin pivot
|
||||
`pivot`::
|
||||
(Required^*^, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot]
|
||||
+
|
||||
.Properties of `pivot`
|
||||
[%collapsible%open]
|
||||
|
|
@ -178,36 +178,36 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot]
|
|||
|
||||
`aggregations` or `aggs`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
|
||||
|
||||
`group_by`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]
|
||||
====
|
||||
//End pivot
|
||||
|
||||
//Begin retention policy
|
||||
`retention_policy`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
+
|
||||
.Properties of `retention_policy`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`time`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`field`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
|
||||
`max_age`:::
|
||||
(Required, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
=====
|
||||
====
|
||||
//End retention policy
|
||||
|
|
@ -215,39 +215,39 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti
|
|||
//Begin settings
|
||||
`settings`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
+
|
||||
.Properties of `settings`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`align_checkpoints`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
`dates_as_epoch_millis`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
`deduce_mappings`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
`docs_per_second`:::
|
||||
(Optional, float)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
`max_page_search_size`:::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
|
||||
`num_failure_retries`:::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries]
|
||||
include::{es-ref-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]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
|
||||
====
|
||||
//End settings
|
||||
|
||||
//Begin source
|
||||
`source`::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
+
|
||||
.Properties of `source`
|
||||
[%collapsible%open]
|
||||
|
|
@ -255,22 +255,22 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
|||
|
||||
`index`:::
|
||||
(Required, string or array)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
|
||||
`query`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
|
||||
`runtime_mappings`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-runtime-mappings-transforms]
|
||||
====
|
||||
//End source
|
||||
|
||||
//Begin sync
|
||||
`sync`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
+
|
||||
.Properties of `sync`
|
||||
[%collapsible%open]
|
||||
|
|
@ -279,18 +279,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
|||
//Begin time
|
||||
`time`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`delay`::::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
|
||||
`field`::::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
+
|
||||
--
|
||||
TIP: It is strongly recommended to use a field that contains the
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ to the latest format as if the <<update-transform>> API was used. The
|
|||
|
||||
`<transform_id>`::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
|
||||
[[reset-transform-query-parms]]
|
||||
== {api-query-parms-title}
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ called again in the meantime.
|
|||
|
||||
`<transform_id>`::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
|
||||
[[schedule-now-transform-query-parms]]
|
||||
== {api-query-parms-title}
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ comma-separated list or a wildcard expression. To stop all {transforms}, use
|
|||
|
||||
`allow_no_match`::
|
||||
(Optional, Boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2]
|
||||
|
||||
`force`::
|
||||
(Optional, Boolean) Set to `true` to stop a failed {transform} or to
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ permanent failure.
|
|||
|
||||
`<transform_id>`::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
||||
|
||||
[[update-transform-query-parms]]
|
||||
== {api-query-parms-title}
|
||||
|
|
@ -82,7 +82,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
|
|||
//Begin dest
|
||||
`dest`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
||||
+
|
||||
.Properties of `dest`
|
||||
[%collapsible%open]
|
||||
|
|
@ -90,12 +90,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest]
|
|||
|
||||
`index`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
|
||||
|
||||
//Begin aliases
|
||||
`aliases`:::
|
||||
(Optional, array of objects)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
||||
+
|
||||
.Properties of `aliases`
|
||||
[%collapsible%open]
|
||||
|
|
@ -103,53 +103,53 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases]
|
|||
|
||||
`alias`::::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-alias]
|
||||
|
||||
`move_on_creation`::::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-aliases-move-on-creation]
|
||||
|
||||
=====
|
||||
//End aliases
|
||||
|
||||
`pipeline`:::
|
||||
(Optional, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
|
||||
====
|
||||
//End dest
|
||||
|
||||
`frequency`::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency]
|
||||
|
||||
//Begin _meta
|
||||
`_meta`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-metadata]
|
||||
//End _meta
|
||||
|
||||
//Begin retention policy
|
||||
`retention_policy`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention]
|
||||
+
|
||||
.Properties of `retention_policy`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`time`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`field`:::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-field]
|
||||
|
||||
`max_age`:::
|
||||
(Required, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-time-max-age]
|
||||
=====
|
||||
====
|
||||
//End retention policy
|
||||
|
|
@ -157,39 +157,39 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-retention-ti
|
|||
//Begin settings
|
||||
`settings`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
|
||||
+
|
||||
.Properties of `settings`
|
||||
[%collapsible%open]
|
||||
====
|
||||
`align_checkpoints`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
|
||||
`dates_as_epoch_millis`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dates-as-epoch-milli]
|
||||
`deduce_mappings`:::
|
||||
(Optional, boolean)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-deduce-mappings]
|
||||
`docs_per_second`:::
|
||||
(Optional, float)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
|
||||
`max_page_search_size`:::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
|
||||
`num_failure_retries`:::
|
||||
(Optional, integer)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-num-failure-retries]
|
||||
include::{es-ref-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]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-unattended]
|
||||
====
|
||||
//End settings
|
||||
|
||||
//Begin source
|
||||
`source`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
||||
+
|
||||
.Properties of `source`
|
||||
[%collapsible%open]
|
||||
|
|
@ -197,18 +197,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-transforms]
|
|||
|
||||
`index`:::
|
||||
(Required, string or array)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
|
||||
|
||||
`query`:::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-query-transforms]
|
||||
====
|
||||
//End source
|
||||
|
||||
//Begin sync
|
||||
`sync`::
|
||||
(Optional, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync]
|
||||
+
|
||||
--
|
||||
NOTE: You can update these properties only if it is a continuous {transform}. You
|
||||
|
|
@ -224,7 +224,7 @@ Instead, clone the {transform} in {kib} and add or remove the `sync` property.
|
|||
//Begin sync.time
|
||||
`time`:::
|
||||
(Required, object)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
||||
+
|
||||
.Properties of `time`
|
||||
[%collapsible%open]
|
||||
|
|
@ -232,11 +232,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time]
|
|||
|
||||
`delay`::::
|
||||
(Optional, <<time-units, time units>>)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-delay]
|
||||
|
||||
`field`::::
|
||||
(Required, string)
|
||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
|
||||
+
|
||||
--
|
||||
TIP: In general, it’s a good idea to use a field that contains the
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue