Skip to content

Commit 3804f37

Browse files
lcawllcawl
committed
[DOCS] Fixes terms in HLRC data frame transform APIs (#44838) (#44865)
1 parent 80b7a14 commit 3804f37

11 files changed

+62
-58
lines changed

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Delete Data Frame Transform API
7+
=== Delete {dataframe-transform} API
8+
9+
Deletes an existing {dataframe-transform}.
810

911
[id="{upid}-{api}-request"]
10-
==== Delete Data Frame Transform Request
12+
==== Delete {dataframe-transform} request
1113

1214
A +{request}+ object requires a non-null `id`.
1315

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@
44
:response: GetDataFrameTransformResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Data Frame Transform API
7+
=== Get {dataframe-transform} API
88

9-
The Get Data Frame Transform API is used get one or more {dataframe-transform}.
9+
Retrieves configuration information about one or more {dataframe-transforms}.
1010
The API accepts a +{request}+ object and returns a +{response}+.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Get Data Frame Request
13+
==== Get {dataframe-transform} request
1414

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

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

24-
==== Optional Arguments
24+
==== Optional arguments
2525

2626
The following arguments are optional.
2727

@@ -40,7 +40,7 @@ include::../execution.asciidoc[]
4040
[id="{upid}-{api}-response"]
4141
==== Response
4242

43-
The returned +{response}+ contains the requested {dataframe-transform}s.
43+
The returned +{response}+ contains the requested {dataframe-transforms}.
4444

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

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

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@
44
:response: GetDataFrameTransformStatsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Data Frame Transform Stats API
7+
=== Get {dataframe-transform} stats API
88

9-
The Get Data Frame Transform Stats API is used read the operational statistics
10-
of one or more {dataframe-transform}s.
9+
Retrieves the operational statistics of one or more {dataframe-transforms}.
1110
The API accepts a +{request}+ object and returns a +{response}+.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Get Data Frame Transform Stats Request
13+
==== Get {dataframe-transform} stats request
1514

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

1918
["source","java",subs="attributes,callouts,macros"]
2019
--------------------------------------------------
2120
include-tagged::{doc-tests-file}[{api}-request]
2221
--------------------------------------------------
2322
<1> Constructing a new GET Stats request referencing an existing {dataframe-transform}
2423

25-
==== Optional Arguments
24+
==== Optional arguments
2625

2726
The following arguments are optional.
2827

2928
["source","java",subs="attributes,callouts,macros"]
3029
--------------------------------------------------
3130
include-tagged::{doc-tests-file}[{api}-request-options]
3231
--------------------------------------------------
33-
<1> The page parameters `from` and `size`. `from` specifies the number of data frame transform stats to skip.
34-
`size` specifies the maximum number of data frame transform stats to get.
32+
<1> The page parameters `from` and `size`. `from` specifies the number of
33+
{dataframe-transform} stats to skip.
34+
`size` specifies the maximum number of {dataframe-transform} stats to get.
3535
Defaults to `0` and `100` respectively.
3636
<2> Whether to ignore if a wildcard expression matches no transforms.
3737

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

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,24 @@
44
:response: PreviewDataFrameTransformResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Preview Data Frame Transform API
7+
=== Preview {dataframe-transform} API
88

9-
The Preview Data Frame Transform API is used to preview the results of
10-
a {dataframe-transform}.
9+
Previews the results of a {dataframe-transform}.
1110

1211
The API accepts a +{request}+ object as a request and returns a +{response}+.
1312

1413
[id="{upid}-{api}-request"]
15-
==== Preview Data Frame Request
14+
==== Preview {dataframe-transform} request
1615

17-
A +{request}+ takes a single argument: a valid data frame transform config.
16+
A +{request}+ takes a single argument: a valid {dataframe-transform} config.
1817

1918
["source","java",subs="attributes,callouts,macros"]
2019
--------------------------------------------------
2120
include-tagged::{doc-tests-file}[{api}-request]
2221
--------------------------------------------------
2322
<1> The source config from which the data should be gathered
2423
<2> The pivot config used to transform the data
25-
<3> The configuration of the {dataframe-job} to preview
24+
<3> The configuration of the {dataframe-transform} to preview
2625

2726
include::../execution.asciidoc[]
2827

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Put Data Frame Transform API
7+
=== Put {dataframe-transform} API
88

9-
The Put Data Frame Transform API is used to create a new {dataframe-transform}.
9+
Creates a new {dataframe-transform}.
1010

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

1313
[id="{upid}-{api}-request"]
14-
==== Put Data Frame Request
14+
==== Put {dataframe-transform} request
1515

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

@@ -22,10 +22,10 @@ include-tagged::{doc-tests-file}[{api}-request]
2222
<1> The configuration of the {dataframe-transform} to create
2323

2424
[id="{upid}-{api}-config"]
25-
==== Data Frame Transform Configuration
25+
==== {dataframe-transform-cap} configuration
2626

27-
The `DataFrameTransformConfig` object contains all the details about the {dataframe-transform}
28-
configuration and contains the following arguments:
27+
The `DataFrameTransformConfig` object contains all the details about the
28+
{dataframe-transform} configuration and contains the following arguments:
2929

3030
["source","java",subs="attributes,callouts,macros"]
3131
--------------------------------------------------

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

+9-7
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,36 @@
44
:response: StartDataFrameTransformResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Start Data Frame Transform API
7+
=== Start {dataframe-transform} API
88

9-
Start a {dataframe-job}.
9+
Starts a {dataframe-transform}.
1010
It accepts a +{request}+ object and responds with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Start Data Frame Request
13+
==== Start {dataframe-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 start request referencing an existing {dataframe-job}
21+
<1> Constructing a new start request referencing an existing
22+
{dataframe-transform}
2223

23-
==== Optional Arguments
24+
==== Optional arguments
2425

2526
The following arguments are optional.
2627

2728
["source","java",subs="attributes,callouts,macros"]
2829
--------------------------------------------------
2930
include-tagged::{doc-tests-file}[{api}-request-options]
3031
--------------------------------------------------
31-
<1> Controls the amount of time to wait until the {dataframe-job} starts.
32+
<1> Controls the amount of time to wait until the {dataframe-transform} starts.
3233

3334
include::../execution.asciidoc[]
3435

3536
==== Response
3637

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

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44
:response: StopDataFrameTransformResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Stop Data Frame Transform API
7+
=== Stop {dataframe-transform} API
88

9-
Stop a started {dataframe-job}.
9+
Stops a started {dataframe-transform}.
1010
It accepts a +{request}+ object and responds with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Stop Data Frame Request
13+
==== Stop {dataframe-transform} request
1414

15-
A +{request}+ object requires a non-null `id`. `id` can be a comma separated list of Ids
16-
or a single Id. Wildcards, `*` and `_all` are also accepted.
15+
A +{request}+ object requires a non-null `id`. `id` can be a comma separated
16+
list of IDs or a single ID. Wildcards, `*` and `_all` are also accepted.
1717

1818

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

25-
==== Optional Arguments
25+
==== Optional arguments
2626

2727
The following arguments are optional.
2828

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

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

3939
==== Response
4040

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

‎docs/java-rest/high-level/execution-no-req.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For methods with requests, see execution.asciidoc
55
////
66

77
[id="{upid}-{api}-sync"]
8-
==== Synchronous Execution
8+
==== Synchronous execution
99

1010
When executing the +{api}+ API in the following manner, the client waits
1111
for the +{response}+ to be returned before continuing with code execution:
@@ -25,7 +25,7 @@ a generic `ElasticsearchException` and adds the original `ResponseException` as
2525
suppressed exception to it.
2626

2727
[id="{upid}-{api}-async"]
28-
==== Asynchronous Execution
28+
==== Asynchronous execution
2929

3030
The +{api}+ API can also be called in an asynchronous fashion so that
3131
the client can return directly. Users need to specify how the response or

‎docs/java-rest/high-level/execution.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ test.
88
////
99

1010
[id="{upid}-{api}-sync"]
11-
==== Synchronous Execution
11+
==== Synchronous execution
1212

1313
When executing a +{request}+ in the following manner, the client waits
1414
for the +{response}+ to be returned before continuing with code execution:
@@ -28,7 +28,7 @@ a generic `ElasticsearchException` and adds the original `ResponseException` as
2828
suppressed exception to it.
2929

3030
[id="{upid}-{api}-async"]
31-
==== Asynchronous Execution
31+
==== Asynchronous execution
3232

3333
Executing a +{request}+ can also be done in an asynchronous fashion so that
3434
the client can return directly. Users need to specify how the response or

‎docs/java-rest/high-level/ml/delete-job.asciidoc

+6-7
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@ The following arguments are optional:
2727
---------------------------------------------------
2828
include-tagged::{doc-tests-file}[{api}-request-force]
2929
---------------------------------------------------
30-
<1> Use to forcefully delete an opened job;
31-
this method is quicker than closing and deleting the job.
32-
Defaults to `false`.
30+
<1> Use to forcefully delete an opened job. This method is quicker than closing
31+
and deleting the job. Defaults to `false`.
3332

3433
["source","java",subs="attributes,callouts,macros"]
3534
---------------------------------------------------
@@ -50,9 +49,9 @@ for completion:
5049
---------------------------------------------------
5150
include-tagged::{doc-tests-file}[{api}-response]
5251
---------------------------------------------------
53-
<1> whether was job deletion was acknowledged or not; will be `null` when set
54-
not to wait for completion
55-
<2> the id of the job deletion task; will be `null` when set to wait for
56-
completion
52+
<1> Whether job deletion was acknowledged or not. It will be `null` when set
53+
to not wait for completion.
54+
<2> The ID of the job deletion task. It will be `null` when set to wait for
55+
completion.
5756

5857
include::../execution.asciidoc[]

‎docs/java-rest/high-level/supported-apis.asciidoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -564,12 +564,14 @@ include::ilm/lifecycle_management_status.asciidoc[]
564564
include::ilm/retry_lifecycle_policy.asciidoc[]
565565
include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
566566

567-
== Data Frame APIs
567+
[[_data_frame_transform_apis]]
568+
== {dataframe-transform-cap} APIs
568569

569570
:upid: {mainid}-dataframe
570571
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
571572

572-
The Java High Level REST Client supports the following Data Frame APIs:
573+
The Java High Level REST Client supports the following {dataframe-transform}
574+
APIs:
573575

574576
* <<{upid}-get-data-frame-transform>>
575577
* <<{upid}-get-data-frame-transform-stats>>

0 commit comments

Comments
 (0)