Skip to content

Commit c0f7317

Browse files
authored
[DOCS] Updates dataframe transform terminology (#46642) (#46756)
1 parent 162bffa commit c0f7317

33 files changed

+372
-376
lines changed

docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Delete {dataframe-transform} API
8+
=== Delete {transform} API
99

10-
Deletes an existing {dataframe-transform}.
10+
Deletes an existing {transform}.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Delete {dataframe-transform} request
13+
==== Delete {transform} request
1414

1515
A +{request}+ object requires a non-null `id`.
1616

1717
["source","java",subs="attributes,callouts,macros"]
1818
---------------------------------------------------
1919
include-tagged::{doc-tests-file}[{api}-request]
2020
---------------------------------------------------
21-
<1> Constructing a new request referencing an existing {dataframe-transform}
22-
<2> Sets the optional argument `force`. When `true`, the {dataframe-transform}
21+
<1> Constructing a new request referencing an existing {transform}
22+
<2> Sets the optional argument `force`. When `true`, the {transform}
2323
is deleted regardless of its current state. The default value is `false`,
24-
meaning that only `stopped` {dataframe-transforms} can be deleted.
24+
meaning that only `stopped` {transforms} can be deleted.
2525

2626
include::../execution.asciidoc[]
2727

2828
[id="{upid}-{api}-response"]
2929
==== Response
3030

31-
The returned +{response}+ object acknowledges the Data Frame Transform deletion.
31+
The returned +{response}+ object acknowledges the {transform} deletion.

docs/java-rest/high-level/dataframe/get_data_frame.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Get {dataframe-transform} API
8+
=== Get {transform} API
99

10-
Retrieves configuration information about one or more {dataframe-transforms}.
10+
Retrieves configuration information about one or more {transforms}.
1111
The API accepts a +{request}+ object and returns a +{response}+.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Get {dataframe-transform} request
14+
==== Get {transform} request
1515

16-
A +{request}+ requires either a {dataframe-transform} ID, a comma separated list
17-
of ids or the special wildcard `_all` to get all {dataframe-transforms}.
16+
A +{request}+ requires either a {transform} ID, a comma separated list
17+
of ids or the special wildcard `_all` to get all {transforms}.
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
23-
<1> Constructing a new GET request referencing an existing {dataframe-transform}
23+
<1> Constructing a new GET request referencing an existing {transform}
2424

2525
==== Optional arguments
2626

@@ -31,17 +31,17 @@ The following arguments are optional.
3131
include-tagged::{doc-tests-file}[{api}-request-options]
3232
--------------------------------------------------
3333
<1> The page parameters `from` and `size`. `from` specifies the number of
34-
{dataframe-transforms} to skip. `size` specifies the maximum number of
35-
{dataframe-transforms} to get. Defaults to `0` and `100` respectively.
36-
<2> Whether to ignore if a wildcard expression matches no transforms.
34+
{transforms} to skip. `size` specifies the maximum number of
35+
{transforms} to get. Defaults to `0` and `100` respectively.
36+
<2> Whether to ignore if a wildcard expression matches no {transforms}.
3737

3838

3939
include::../execution.asciidoc[]
4040

4141
[id="{upid}-{api}-response"]
4242
==== Response
4343

44-
The returned +{response}+ contains the requested {dataframe-transforms}.
44+
The returned +{response}+ contains the requested {transforms}.
4545

4646
["source","java",subs="attributes,callouts,macros"]
4747
--------------------------------------------------

docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Get {dataframe-transform} stats API
8+
=== Get {transform} stats API
99

10-
Retrieves the operational statistics of one or more {dataframe-transforms}.
10+
Retrieves the operational statistics of one or more {transforms}.
1111
The API accepts a +{request}+ object and returns a +{response}+.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Get {dataframe-transform} stats request
14+
==== Get {transform} stats request
1515

16-
A +{request}+ requires a data frame transform id or the special wildcard `_all`
17-
to get the statistics for all {dataframe-transforms}.
16+
A +{request}+ requires a {transform} id or the special wildcard `_all`
17+
to get the statistics for all {transforms}.
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
23-
<1> Constructing a new GET Stats request referencing an existing {dataframe-transform}
23+
<1> Constructing a new GET Stats request referencing an existing {transform}
2424

2525
==== Optional arguments
2626

@@ -31,26 +31,26 @@ The following arguments are optional.
3131
include-tagged::{doc-tests-file}[{api}-request-options]
3232
--------------------------------------------------
3333
<1> The page parameters `from` and `size`. `from` specifies the number of
34-
{dataframe-transform} stats to skip.
35-
`size` specifies the maximum number of {dataframe-transform} stats to get.
34+
{transform} stats to skip.
35+
`size` specifies the maximum number of {transform} stats to get.
3636
Defaults to `0` and `100` respectively.
37-
<2> Whether to ignore if a wildcard expression matches no transforms.
37+
<2> Whether to ignore if a wildcard expression matches no {transforms}.
3838

3939

4040
include::../execution.asciidoc[]
4141

4242
[id="{upid}-{api}-response"]
4343
==== Response
4444

45-
The returned +{response}+ contains the requested {dataframe-transform} statistics.
45+
The returned +{response}+ contains the requested {transform} statistics.
4646

4747
["source","java",subs="attributes,callouts,macros"]
4848
--------------------------------------------------
4949
include-tagged::{doc-tests-file}[{api}-response]
5050
--------------------------------------------------
5151
<1> The response contains a list of `DataFrameTransformStats` objects
52-
<2> The running state of the transform, for example `started`, `indexing`, etc.
53-
<3> The overall transform statistics recording the number of documents indexed etc.
54-
<4> The progress of the current run in the transform. Supplies the number of docs left until the next checkpoint
52+
<2> The running state of the {transform}, for example `started`, `indexing`, etc.
53+
<3> The overall {transform} statistics recording the number of documents indexed etc.
54+
<4> The progress of the current run in the {transform}. Supplies the number of docs left until the next checkpoint
5555
and the total number of docs expected.
5656
<5> The assigned node information if the task is currently assigned to a node and running.

docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Preview {dataframe-transform} API
8+
=== Preview {transform} API
99

10-
Previews the results of a {dataframe-transform}.
10+
Previews the results of a {transform}.
1111

1212
The API accepts a +{request}+ object as a request and returns a +{response}+.
1313

1414
[id="{upid}-{api}-request"]
15-
==== Preview {dataframe-transform} request
15+
==== Preview {transform} request
1616

17-
A +{request}+ takes a single argument: a valid {dataframe-transform} config.
17+
A +{request}+ takes a single argument: a valid {transform} config.
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
2323
<1> The source config from which the data should be gathered
2424
<2> The pivot config used to transform the data
25-
<3> The configuration of the {dataframe-transform} to preview
25+
<3> The configuration of the {transform} to preview
2626

2727
include::../execution.asciidoc[]
2828

docs/java-rest/high-level/dataframe/put_data_frame.asciidoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,43 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Put {dataframe-transform} API
8+
=== Put {transform} API
99

10-
Creates a new {dataframe-transform}.
10+
Creates a new {transform}.
1111

1212
The API accepts a +{request}+ object as a request and returns a +{response}+.
1313

1414
[id="{upid}-{api}-request"]
15-
==== Put {dataframe-transform} request
15+
==== Put {transform} request
1616

1717
A +{request}+ requires the following argument:
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
23-
<1> The configuration of the {dataframe-transform} to create
23+
<1> The configuration of the {transform} to create
2424
<2> Whether or not to wait to run deferrable validations until `_start` is called.
25-
This option should be used with care as the created {dataframe-transform} will run
25+
This option should be used with care as the created {transform} will run
2626
with the privileges of the user creating it. Meaning, if they do not have privileges,
2727
such an error will not be visible until `_start` is called.
2828

2929
[id="{upid}-{api}-config"]
30-
==== {dataframe-transform-cap} configuration
30+
==== {transform-cap} configuration
3131

3232
The `DataFrameTransformConfig` object contains all the details about the
33-
{dataframe-transform} configuration and contains the following arguments:
33+
{transform} configuration and contains the following arguments:
3434

3535
["source","java",subs="attributes,callouts,macros"]
3636
--------------------------------------------------
3737
include-tagged::{doc-tests-file}[{api}-config]
3838
--------------------------------------------------
39-
<1> The {dataframe-transform} ID
39+
<1> The {transform} ID
4040
<2> The source indices and query from which to gather data
4141
<3> The destination index and optional pipeline
4242
<4> How often to check for updates to the source indices
4343
<5> The PivotConfig
44-
<6> Optional free text description of the transform
44+
<6> Optional free text description of the {transform}
4545

4646
[id="{upid}-{api}-query-config"]
4747

@@ -84,8 +84,8 @@ include-tagged::{doc-tests-file}[{api}-pivot-config]
8484
--------------------------------------------------
8585
<1> The `GroupConfig` to use in the pivot
8686
<2> The aggregations to use
87-
<3> The maximum paging size for the transform when pulling data
88-
from the source. The size dynamically adjusts as the transform
87+
<3> The maximum paging size for the {transform} when pulling data
88+
from the source. The size dynamically adjusts as the {transform}
8989
is running to recover from and prevent OOM issues.
9090

9191
===== GroupConfig
@@ -121,4 +121,4 @@ include::../execution.asciidoc[]
121121
==== Response
122122

123123
The returned +{response}+ acknowledges the successful creation of
124-
the new {dataframe-transform} or an error if the configuration is invalid.
124+
the new {transform} or an error if the configuration is invalid.

docs/java-rest/high-level/dataframe/start_data_frame.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Start {dataframe-transform} API
8+
=== Start {transform} API
99

10-
Starts a {dataframe-transform}.
10+
Starts a {transform}.
1111
It accepts a +{request}+ object and responds with a +{response}+ object.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Start {dataframe-transform} request
14+
==== Start {transform} request
1515

1616
A +{request}+ object requires a non-null `id`.
1717

@@ -20,7 +20,7 @@ A +{request}+ object requires a non-null `id`.
2020
include-tagged::{doc-tests-file}[{api}-request]
2121
---------------------------------------------------
2222
<1> Constructing a new start request referencing an existing
23-
{dataframe-transform}
23+
{transform}
2424

2525
==== Optional arguments
2626

@@ -30,11 +30,11 @@ The following arguments are optional.
3030
--------------------------------------------------
3131
include-tagged::{doc-tests-file}[{api}-request-options]
3232
--------------------------------------------------
33-
<1> Controls the amount of time to wait until the {dataframe-transform} starts.
33+
<1> Controls the amount of time to wait until the {transform} starts.
3434

3535
include::../execution.asciidoc[]
3636

3737
==== Response
3838

39-
The returned +{response}+ object acknowledges the {dataframe-transform} has
39+
The returned +{response}+ object acknowledges the {transform} has
4040
started.

docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Stop {dataframe-transform} API
8+
=== Stop {transform} API
99

10-
Stops a started {dataframe-transform}.
10+
Stops a started {transform}.
1111
It accepts a +{request}+ object and responds with a +{response}+ object.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Stop {dataframe-transform} request
14+
==== Stop {transform} request
1515

1616
A +{request}+ object requires a non-null `id`. `id` can be a comma separated
1717
list of IDs or a single ID. Wildcards, `*` and `_all` are also accepted.
@@ -21,7 +21,7 @@ list of IDs or a single ID. Wildcards, `*` and `_all` are also accepted.
2121
---------------------------------------------------
2222
include-tagged::{doc-tests-file}[{api}-request]
2323
---------------------------------------------------
24-
<1> Constructing a new stop request referencing an existing {dataframe-transform}
24+
<1> Constructing a new stop request referencing an existing {transform}
2525

2626
==== Optional arguments
2727

@@ -32,11 +32,11 @@ The following arguments are optional.
3232
include-tagged::{doc-tests-file}[{api}-request-options]
3333
--------------------------------------------------
3434
<1> If true wait for the data frame task to stop before responding
35-
<2> Controls the amount of time to wait until the {dataframe-transform} stops.
36-
<3> Whether to ignore if a wildcard expression matches no transforms.
35+
<2> Controls the amount of time to wait until the {transform} stops.
36+
<3> Whether to ignore if a wildcard expression matches no {transforms}.
3737

3838
include::../execution.asciidoc[]
3939

4040
==== Response
4141

42-
The returned +{response}+ object acknowledges the {dataframe-transform} has stopped.
42+
The returned +{response}+ object acknowledges the {transform} has stopped.

docs/java-rest/high-level/dataframe/update_data_frame.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,33 @@
55
--
66
[role="xpack"]
77
[id="{upid}-{api}"]
8-
=== Update {dataframe-transform} API
8+
=== Update {transform} API
99

10-
Updates an existing {dataframe-transform}.
10+
Updates an existing {transform}.
1111

1212
The API accepts a +{request}+ object as a request and returns a +{response}+.
1313

1414
[id="{upid}-{api}-request"]
15-
==== Update {dataframe-transform} request
15+
==== Update {transform} request
1616

1717
A +{request}+ requires the following argument:
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
23-
<1> The update configuration with which to update the {dataframe-transform}.
23+
<1> The update configuration with which to update the {transform}.
2424
<2> The ID of the configuration to update.
2525
<3> Whether or not to wait to run deferrable validations until `_start` is called.
26-
This option should be used with care as the created {dataframe-transform} will run
26+
This option should be used with care as the created {transform} will run
2727
with the privileges of the user creating it. Meaning, if they do not have privileges,
2828
such an error will not be visible until `_start` is called.
2929

3030
[id="{upid}-{api}-config"]
31-
==== {dataframe-transform-cap} update configuration
31+
==== {transform-cap} update configuration
3232

3333
The `DataFrameTransformConfigUpdate` object contains all the details about updated
34-
{dataframe-transform} configuration and contains the following arguments:
34+
{transform} configuration and contains the following arguments:
3535

3636
["source","java",subs="attributes,callouts,macros"]
3737
--------------------------------------------------
@@ -40,13 +40,13 @@ include-tagged::{doc-tests-file}[{api}-config]
4040
<1> The source indices and query from which to gather data.
4141
<2> The destination index and optional pipeline.
4242
<3> How often to check for updates to the source indices.
43-
<4> How to keep the {dataframe-transform} in sync with incoming data.
44-
<5> Optional free text description of the transform.
43+
<4> How to keep the {transform} in sync with incoming data.
44+
<5> Optional free text description of the {transform}.
4545

4646
include::../execution.asciidoc[]
4747

4848
[id="{upid}-{api}-response"]
4949
==== Response
5050

51-
The returned +{response}+ contains the updated {dataframe-transform} configuration
51+
The returned +{response}+ contains the updated {transform} configuration
5252
or an error if the update failed or is invalid.

0 commit comments

Comments
 (0)