[Transform] rename data frame transform to transform for hlrc client (#46933)

rename data frame transform to transform for hlrc
This commit is contained in:
Hendrik Muhs 2019-09-25 07:38:17 +02:00 committed by GitHub
parent 07761530c1
commit fd3dc4da77
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
90 changed files with 1258 additions and 1258 deletions

View file

@ -580,7 +580,7 @@ include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
== {transform-cap} APIs
:upid: {mainid}
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
:doc-tests-file: {doc-tests}/TransformDocumentationIT.java
The Java High Level REST Client supports the following {transform}
APIs:

View file

@ -1,6 +1,6 @@
--
:api: delete-transform
:request: DeleteDataFrameTransformRequest
:request: DeleteTransformRequest
:response: AcknowledgedResponse
--
[role="xpack"]

View file

@ -1,7 +1,7 @@
--
:api: get-transform
:request: GetDataFrameTransformRequest
:response: GetDataFrameTransformResponse
:request: GetTransformRequest
:response: GetTransformResponse
--
[role="xpack"]
[id="{upid}-{api}"]
@ -46,4 +46,4 @@ The returned +{response}+ contains the requested {transforms}.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
--------------------------------------------------

View file

@ -1,7 +1,7 @@
--
:api: get-transform-stats
:request: GetDataFrameTransformStatsRequest
:response: GetDataFrameTransformStatsResponse
:request: GetTransformStatsRequest
:response: GetTransformStatsResponse
--
[role="xpack"]
[id="{upid}-{api}"]
@ -48,7 +48,7 @@ The returned +{response}+ contains the requested {transform} statistics.
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The response contains a list of `DataFrameTransformStats` objects
<1> The response contains a list of `TransformStats` objects
<2> The running state of the {transform}, for example `started`, `indexing`, etc.
<3> The overall {transform} statistics recording the number of documents indexed etc.
<4> The progress of the current run in the {transform}. Supplies the number of docs left until the next checkpoint

View file

@ -1,7 +1,7 @@
--
:api: preview-transform
:request: PreviewDataFrameTransformRequest
:response: PreviewDataFrameTransformResponse
:request: PreviewTransformRequest
:response: PreviewTransformResponse
--
[role="xpack"]
[id="{upid}-{api}"]

View file

@ -1,6 +1,6 @@
--
:api: put-transform
:request: PutDataFrameTransformRequest
:request: PutTransformRequest
:response: AcknowledgedResponse
--
[role="xpack"]
@ -29,7 +29,7 @@ such an error will not be visible until `_start` is called.
[id="{upid}-{api}-config"]
==== {transform-cap} configuration
The `DataFrameTransformConfig` object contains all the details about the
The `TransformConfig` object contains all the details about the
{transform} configuration and contains the following arguments:
["source","java",subs="attributes,callouts,macros"]

View file

@ -1,7 +1,7 @@
--
:api: start-transform
:request: StartDataFrameTransformRequest
:response: StartDataFrameTransformResponse
:request: StartTransformRequest
:response: StartTransformResponse
--
[role="xpack"]
[id="{upid}-{api}"]
@ -37,4 +37,4 @@ include::../execution.asciidoc[]
==== Response
The returned +{response}+ object acknowledges the {transform} has
started.
started.

View file

@ -1,7 +1,7 @@
--
:api: stop-transform
:request: StopDataFrameTransformRequest
:response: StopDataFrameTransformResponse
:request: StopTransformRequest
:response: StopTransformResponse
--
[role="xpack"]
[id="{upid}-{api}"]
@ -31,7 +31,7 @@ The following arguments are optional.
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-options]
--------------------------------------------------
<1> If true wait for the data frame task to stop before responding
<1> If true wait for the transform task to stop before responding
<2> Controls the amount of time to wait until the {transform} stops.
<3> Whether to ignore if a wildcard expression matches no {transforms}.
@ -39,4 +39,4 @@ include::../execution.asciidoc[]
==== Response
The returned +{response}+ object acknowledges the {transform} has stopped.
The returned +{response}+ object acknowledges the {transform} has stopped.

View file

@ -1,7 +1,7 @@
--
:api: update-transform
:request: UpdateDataFrameTransformRequest
:response: UpdateDataFrameTransformResponse
:request: UpdateTransformRequest
:response: UpdateTransformResponse
--
[role="xpack"]
[id="{upid}-{api}"]
@ -30,7 +30,7 @@ such an error will not be visible until `_start` is called.
[id="{upid}-{api}-config"]
==== {transform-cap} update configuration
The `DataFrameTransformConfigUpdate` object contains all the details about updated
The `TransformConfigUpdate` object contains all the details about updated
{transform} configuration and contains the following arguments:
["source","java",subs="attributes,callouts,macros"]