Skip to content

Commit 7a17359

Browse files
authored
[7.3][DOCS] Updates dataframe transform terminology (#46642) (#46759)
1 parent 3fdd65a commit 7a17359

27 files changed

+303
-299
lines changed

docs/java-rest/high-level/dataframe/delete_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-
=== 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}
21+
<1> Constructing a new request referencing an existing {transform}
2222

2323
include::../execution.asciidoc[]
2424

2525
[id="{upid}-{api}-response"]
2626
==== Response
2727

28-
The returned +{response}+ object acknowledges the Data Frame Transform deletion.
28+
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: 14 additions & 14 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,27 +31,27 @@ 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 `DataFrameTransformStateAndStats` objects
52-
<2> The running state of the transform task e.g `started`
53-
<3> The running state of the transform indexer e.g `started`, `indexing`, etc.
54-
<4> The overall transform statistics recording the number of documents indexed etc.
55-
<5> 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} task e.g `started`
53+
<3> The running state of the {transform} indexer e.g `started`, `indexing`, etc.
54+
<4> The overall {transform} statistics recording the number of documents indexed etc.
55+
<5> The progress of the current run in the {transform}. Supplies the number of docs left until the next checkpoint
5656
and the total number of docs expected.
5757
<6> 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: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,39 @@
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

2525
[id="{upid}-{api}-config"]
26-
==== {dataframe-transform-cap} configuration
26+
==== {transform-cap} configuration
2727

2828
The `DataFrameTransformConfig` object contains all the details about the
29-
{dataframe-transform} configuration and contains the following arguments:
29+
{transform} configuration and contains the following arguments:
3030

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

4242
[id="{upid}-{api}-query-config"]
4343

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

8787
===== GroupConfig
@@ -117,4 +117,4 @@ include::../execution.asciidoc[]
117117
==== Response
118118

119119
The returned +{response}+ acknowledges the successful creation of
120-
the new {dataframe-transform} or an error if the configuration is invalid.
120+
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/supported-apis.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -573,12 +573,12 @@ include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
573573

574574
[role="xpack"]
575575
[[_data_frame_transform_apis]]
576-
== {dataframe-transform-cap} APIs
576+
== {transform-cap} APIs
577577

578578
:upid: {mainid}-dataframe
579579
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
580580

581-
The Java High Level REST Client supports the following {dataframe-transform}
581+
The Java High Level REST Client supports the following {transform}
582582
APIs:
583583

584584
* <<{upid}-get-data-frame-transform>>
Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[delete-data-frame-transform]]
4-
=== Delete {dataframe-transforms} API
4+
=== Delete {transforms} API
55

66
[subs="attributes"]
77
++++
8-
<titleabbrev>Delete {dataframe-transforms}</titleabbrev>
8+
<titleabbrev>Delete {transforms}</titleabbrev>
99
++++
1010

11-
Deletes an existing {dataframe-transform}.
11+
Deletes an existing {transform}.
1212

1313
beta[]
1414

1515
[[delete-data-frame-transform-request]]
1616
==== {api-request-title}
1717

18-
`DELETE _data_frame/transforms/<data_frame_transform_id>`
18+
`DELETE _data_frame/transforms/<transform_id>`
1919

2020
[[delete-data-frame-transform-prereqs]]
2121
==== {api-prereq-title}
2222

23-
* Before you can delete the {dataframe-transform}, you must stop it.
23+
* Before you can delete the {transform}, you must stop it.
2424
* If the {es} {security-features} are enabled, you must have
2525
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
2626
`data_frame_transforms_admin` role has these privileges. For more information,
@@ -31,8 +31,8 @@ see {stack-ov}/security-privileges.html[Security privileges] and
3131
[[delete-data-frame-transform-path-parms]]
3232
==== {api-path-parms-title}
3333

34-
`<data_frame_transform_id>`::
35-
(Required, string) Identifier for the {dataframe-transform}.
34+
`<transform_id>`::
35+
(Required, string) Identifier for the {transform}.
3636

3737

3838
[[delete-data-frame-transform-examples]]
@@ -45,11 +45,12 @@ DELETE _data_frame/transforms/ecommerce_transform
4545
// CONSOLE
4646
// TEST[skip:setup kibana sample data]
4747

48-
When the {dataframe-transform} is deleted, you receive the following results:
48+
When the {transform} is deleted, you receive the following results:
49+
4950
[source,js]
5051
----
5152
{
5253
"acknowledged" : true
5354
}
5455
----
55-
// TESTRESPONSE
56+
// TESTRESPONSE

0 commit comments

Comments
 (0)