Skip to content

[7.4][DOCS] Updates dataframe transform terminology (#46642) #46756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Delete {dataframe-transform} API
=== Delete {transform} API

Deletes an existing {dataframe-transform}.
Deletes an existing {transform}.

[id="{upid}-{api}-request"]
==== Delete {dataframe-transform} request
==== Delete {transform} request

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

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

include::../execution.asciidoc[]

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

The returned +{response}+ object acknowledges the Data Frame Transform deletion.
The returned +{response}+ object acknowledges the {transform} deletion.
20 changes: 10 additions & 10 deletions docs/java-rest/high-level/dataframe/get_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Get {dataframe-transform} API
=== Get {transform} API

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

[id="{upid}-{api}-request"]
==== Get {dataframe-transform} request
==== Get {transform} request

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

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

==== Optional arguments

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


include::../execution.asciidoc[]

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

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

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Expand Down
26 changes: 13 additions & 13 deletions docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Get {dataframe-transform} stats API
=== Get {transform} stats API

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

[id="{upid}-{api}-request"]
==== Get {dataframe-transform} stats request
==== Get {transform} stats request

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

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

==== Optional arguments

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


include::../execution.asciidoc[]

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

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

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The response contains a list of `DataFrameTransformStats` 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
<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
and the total number of docs expected.
<5> The assigned node information if the task is currently assigned to a node and running.
10 changes: 5 additions & 5 deletions docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Preview {dataframe-transform} API
=== Preview {transform} API

Previews the results of a {dataframe-transform}.
Previews the results of a {transform}.

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

[id="{upid}-{api}-request"]
==== Preview {dataframe-transform} request
==== Preview {transform} request

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

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

include::../execution.asciidoc[]

Expand Down
24 changes: 12 additions & 12 deletions docs/java-rest/high-level/dataframe/put_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,43 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Put {dataframe-transform} API
=== Put {transform} API

Creates a new {dataframe-transform}.
Creates a new {transform}.

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

[id="{upid}-{api}-request"]
==== Put {dataframe-transform} request
==== Put {transform} request

A +{request}+ requires the following argument:

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

[id="{upid}-{api}-config"]
==== {dataframe-transform-cap} configuration
==== {transform-cap} configuration

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

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

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

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

===== GroupConfig
Expand Down Expand Up @@ -121,4 +121,4 @@ include::../execution.asciidoc[]
==== Response

The returned +{response}+ acknowledges the successful creation of
the new {dataframe-transform} or an error if the configuration is invalid.
the new {transform} or an error if the configuration is invalid.
12 changes: 6 additions & 6 deletions docs/java-rest/high-level/dataframe/start_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Start {dataframe-transform} API
=== Start {transform} API

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

[id="{upid}-{api}-request"]
==== Start {dataframe-transform} request
==== Start {transform} request

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

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

==== Optional arguments

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

include::../execution.asciidoc[]

==== Response

The returned +{response}+ object acknowledges the {dataframe-transform} has
The returned +{response}+ object acknowledges the {transform} has
started.
14 changes: 7 additions & 7 deletions docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Stop {dataframe-transform} API
=== Stop {transform} API

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

[id="{upid}-{api}-request"]
==== Stop {dataframe-transform} request
==== Stop {transform} request

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

==== Optional arguments

Expand All @@ -32,11 +32,11 @@ 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
<2> Controls the amount of time to wait until the {dataframe-transform} stops.
<3> Whether to ignore if a wildcard expression matches no transforms.
<2> Controls the amount of time to wait until the {transform} stops.
<3> Whether to ignore if a wildcard expression matches no {transforms}.

include::../execution.asciidoc[]

==== Response

The returned +{response}+ object acknowledges the {dataframe-transform} has stopped.
The returned +{response}+ object acknowledges the {transform} has stopped.
20 changes: 10 additions & 10 deletions docs/java-rest/high-level/dataframe/update_data_frame.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,33 @@
--
[role="xpack"]
[id="{upid}-{api}"]
=== Update {dataframe-transform} API
=== Update {transform} API

Updates an existing {dataframe-transform}.
Updates an existing {transform}.

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

[id="{upid}-{api}-request"]
==== Update {dataframe-transform} request
==== Update {transform} request

A +{request}+ requires the following argument:

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

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

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

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

include::../execution.asciidoc[]

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

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