Skip to content

Commit cb2080d

Browse files
committed
Merge branch 'master' into dateflds
2 parents 695183e + 4ed6e8a commit cb2080d

File tree

40 files changed

+825
-167
lines changed

40 files changed

+825
-167
lines changed

docs/changelog/81266.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pr: 81266
2+
summary: "Script: keyword fields api support"
3+
area: Infra/Scripting
4+
type: enhancement
5+
issues: []

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,9 +1107,7 @@ end::timeout[]
11071107
end::timeoutparms[]
11081108

11091109
tag::transform-id[]
1110-
Identifier for the {transform}. This identifier can contain lowercase
1111-
alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64
1112-
character limit and must start and end with alphanumeric characters.
1110+
Identifier for the {transform}.
11131111
end::transform-id[]
11141112

11151113
tag::transform-id-wildcard[]

docs/reference/transform/apis/delete-transform.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
3636
current state. The default value is `false`, meaning that the {transform} must be
3737
`stopped` before it can be deleted.
3838

39+
`timeout`::
40+
(Optional, time)
41+
Period to wait for a response. If no response is received before the timeout
42+
expires, the request fails and returns an error. Defaults to `30s`.
43+
3944
[[delete-transform-examples]]
4045
== {api-examples-title}
4146

docs/reference/transform/apis/preview-transform.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ Id of the {transform} to preview.
6464
NOTE: If you provide the `<transform_id>` as a path parameter, you cannot
6565
provide {transform} configuration details in the request body.
6666

67+
[[preview-transform-query-parms]]
68+
== {api-query-parms-title}
69+
70+
`timeout`::
71+
(Optional, time)
72+
Period to wait for a response. If no response is received before the timeout
73+
expires, the request fails and returns an error. Defaults to `30s`.
74+
6775
[[preview-transform-request-body]]
6876
== {api-request-body-title}
6977

docs/reference/transform/apis/put-transform.asciidoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,22 @@ cannot use both in a single {transform}.
6565

6666
`<transform_id>`::
6767
(Required, string)
68-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
68+
Identifier for the {transform}. This identifier can contain lowercase
69+
alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64
70+
character limit and must start and end with alphanumeric characters.
6971

7072
[[put-transform-query-parms]]
7173
== {api-query-parms-title}
7274

7375
`defer_validation`::
74-
(Optional, Boolean) When `true`, deferrable validations are not run. This
75-
behavior may be desired if the source index does not exist until after the
76-
{transform} is created.
76+
(Optional, Boolean) When `true`, deferrable validations are not run. This
77+
behavior may be desired if the source index does not exist until after the
78+
{transform} is created.
79+
80+
`timeout`::
81+
(Optional, time)
82+
Period to wait for a response. If no response is received before the timeout
83+
expires, the request fails and returns an error. Defaults to `30s`.
7784

7885
[role="child_attributes"]
7986
[[put-transform-request-body]]

docs/reference/transform/apis/reset-transform.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ If this value is `true`, the {transform} is reset regardless of its current
4545
state. If it's false, the {transform} must be `stopped` before it can be reset.
4646
The default value is `false`
4747

48+
`timeout`::
49+
(Optional, time)
50+
Period to wait for a response. If no response is received before the timeout
51+
expires, the request fails and returns an error. Defaults to `30s`.
52+
4853
[[reset-transform-examples]]
4954
== {api-examples-title}
5055

docs/reference/transform/apis/start-transform.asciidoc

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<titleabbrev>Start {transform}</titleabbrev>
88
++++
99

10-
Starts one or more {transforms}.
10+
Starts a {transform}.
1111

1212
[[start-transform-request]]
1313
== {api-request-title}
@@ -39,8 +39,9 @@ fields in the destination index are derived from scripts (as in the case of
3939
If it is a latest {transform}, it does not deduce mapping definitions; it uses
4040
dynamic mappings.
4141

42-
TIP: To use explicit mappings, create the destination index before you start the {transform}. Alternatively, you can create an index template, though it does not affect the
43-
deduced mappings in a pivot {transform}.
42+
TIP: To use explicit mappings, create the destination index before you start the
43+
{transform}. Alternatively, you can create an index template, though it does not
44+
affect the deduced mappings in a pivot {transform}.
4445

4546
When the {transform} starts, a series of validations occur to ensure
4647
its success. If you deferred validation when you created the
@@ -56,7 +57,16 @@ required privileges on the source and destination indices, the
5657

5758
`<transform_id>`::
5859
(Required, string)
59-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
60+
Identifier for the {transform}.
61+
62+
[[start-transform-query-parms]]
63+
== {api-query-parms-title}
64+
65+
`timeout`::
66+
(Optional, time)
67+
Period to wait for a response. If no response is received before the timeout
68+
expires, the request fails and returns an error. Defaults to `30s`.
69+
6070

6171
[[start-transform-example]]
6272
== {api-examples-title}

docs/reference/transform/apis/stop-transform.asciidoc

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,14 @@ Requires the `manage_transform` cluster privilege. This privilege is included
2727
in the `transform_admin` built-in role.
2828

2929

30-
[[stop-transform-desc]]
31-
== {api-description-title}
32-
33-
You can stop multiple {transforms} in a single API request by using a
34-
comma-separated list of {transforms} or a wildcard expression.
35-
All {transforms} can be stopped by using `_all` or `*` as the
36-
`<transform_id>`.
37-
38-
3930
[[stop-transform-path-parms]]
4031
== {api-path-parms-title}
4132

4233
`<transform_id>`::
4334
(Required, string)
44-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
35+
Identifier for the transform. To stop multiple {transforms}, use a
36+
comma-separated list or a wildcard expression. To stop all {transforms}, use
37+
`_all` or `*` as the identifier.
4538

4639
[[stop-transform-query-parms]]
4740
== {api-query-parms-title}
@@ -61,18 +54,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transfo
6154
more than `timeout` time has passed, the API throws a timeout exception. Even
6255
if a timeout exception is thrown, the stop request is still processing and
6356
eventually moves the {transform} to `STOPPED`. The timeout simply means the API
64-
call itself timed out while waiting for the status change. Defaults to `30s`
65-
66-
`wait_for_completion`::
67-
(Optional, Boolean) If set to `true`, causes the API to block until the indexer
68-
state completely stops. If set to `false`, the API returns immediately and the
69-
indexer will be stopped asynchronously in the background. Defaults to `false`.
57+
call itself timed out while waiting for the status change. Defaults to `30s`.
7058

7159
`wait_for_checkpoint`::
7260
(Optional, Boolean) If set to `true`, the transform will not completely stop
7361
until the current checkpoint is completed. If set to `false`, the {transform}
7462
stops as soon as possible. Defaults to `false`.
7563

64+
`wait_for_completion`::
65+
(Optional, Boolean) If set to `true`, causes the API to block until the indexer
66+
state completely stops. If set to `false`, the API returns immediately and the
67+
indexer will be stopped asynchronously in the background. Defaults to `false`.
68+
7669
[[stop-transform-response-codes]]
7770
== {api-response-codes-title}
7871

docs/reference/transform/apis/update-transform.asciidoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,14 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
6363
== {api-query-parms-title}
6464

6565
`defer_validation`::
66-
(Optional, Boolean) When `true`, deferrable validations are not run. This
67-
behavior may be desired if the source index does not exist until after the
68-
{transform} is updated.
66+
(Optional, Boolean) When `true`, deferrable validations are not run. This
67+
behavior may be desired if the source index does not exist until after the
68+
{transform} is updated.
69+
70+
`timeout`::
71+
(Optional, time)
72+
Period to wait for a response. If no response is received before the timeout
73+
expires, the request fails and returns an error. Defaults to `30s`.
6974

7075
[role="child_attributes"]
7176
[[update-transform-request-body]]

docs/reference/transform/apis/upgrade-transforms.asciidoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,13 @@ destination index remains unchanged.
5959
== {api-query-parms-title}
6060

6161
`dry_run`::
62-
(Optional, Boolean) When `true`, only checks for updates but does not execute
63-
them. Defaults to `false`.
62+
(Optional, Boolean) When `true`, only checks for updates but does not execute
63+
them. Defaults to `false`.
64+
65+
`timeout`::
66+
(Optional, time)
67+
Period to wait for a response. If no response is received before the timeout
68+
expires, the request fails and returns an error. Defaults to `30s`.
6469

6570

6671
[[upgrade-transforms-response-body]]

0 commit comments

Comments
 (0)