parent
48757da6e1
commit
6a60fd6d30
|
@ -4,10 +4,12 @@
|
||||||
:response: AcknowledgedResponse
|
:response: AcknowledgedResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Delete Data Frame Transform API
|
=== Delete {dataframe-transform} API
|
||||||
|
|
||||||
|
Deletes an existing {dataframe-transform}.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Delete Data Frame Transform Request
|
==== Delete {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ object requires a non-null `id`.
|
A +{request}+ object requires a non-null `id`.
|
||||||
|
|
||||||
|
|
|
@ -4,16 +4,16 @@
|
||||||
:response: GetDataFrameTransformResponse
|
:response: GetDataFrameTransformResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Get Data Frame Transform API
|
=== Get {dataframe-transform} API
|
||||||
|
|
||||||
The Get Data Frame Transform API is used get one or more {dataframe-transform}.
|
Retrieves configuration information about one or more {dataframe-transforms}.
|
||||||
The API accepts a +{request}+ object and returns a +{response}+.
|
The API accepts a +{request}+ object and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Get Data Frame Request
|
==== Get {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ requires either a data frame transform id, a comma separated list of ids or
|
A +{request}+ requires either a {dataframe-transform} ID, a comma separated list
|
||||||
the special wildcard `_all` to get all {dataframe-transforms}
|
of ids or the special wildcard `_all` to get all {dataframe-transforms}.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -21,7 +21,7 @@ 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 {dataframe-transform}
|
||||||
|
|
||||||
==== Optional Arguments
|
==== Optional arguments
|
||||||
|
|
||||||
The following arguments are optional.
|
The following arguments are optional.
|
||||||
|
|
||||||
|
@ -40,7 +40,7 @@ include::../execution.asciidoc[]
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ contains the requested {dataframe-transform}s.
|
The returned +{response}+ contains the requested {dataframe-transforms}.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -4,17 +4,16 @@
|
||||||
:response: GetDataFrameTransformStatsResponse
|
:response: GetDataFrameTransformStatsResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Get Data Frame Transform Stats API
|
=== Get {dataframe-transform} stats API
|
||||||
|
|
||||||
The Get Data Frame Transform Stats API is used read the operational statistics
|
Retrieves the operational statistics of one or more {dataframe-transforms}.
|
||||||
of one or more {dataframe-transform}s.
|
|
||||||
The API accepts a +{request}+ object and returns a +{response}+.
|
The API accepts a +{request}+ object and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Get Data Frame Transform Stats Request
|
==== Get {dataframe-transform} stats request
|
||||||
|
|
||||||
A +{request}+ requires a data frame transform id or the special wildcard `_all`
|
A +{request}+ requires a data frame transform id or the special wildcard `_all`
|
||||||
to get the statistics for all {dataframe-transform}s
|
to get the statistics for all {dataframe-transforms}.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -22,7 +21,7 @@ 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 {dataframe-transform}
|
||||||
|
|
||||||
==== Optional Arguments
|
==== Optional arguments
|
||||||
|
|
||||||
The following arguments are optional.
|
The following arguments are optional.
|
||||||
|
|
||||||
|
@ -30,8 +29,9 @@ The following arguments are optional.
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request-options]
|
include-tagged::{doc-tests-file}[{api}-request-options]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> The page parameters `from` and `size`. `from` specifies the number of data frame transform stats to skip.
|
<1> The page parameters `from` and `size`. `from` specifies the number of
|
||||||
`size` specifies the maximum number of data frame transform stats to get.
|
{dataframe-transform} stats to skip.
|
||||||
|
`size` specifies the maximum number of {dataframe-transform} stats to get.
|
||||||
Defaults to `0` and `100` respectively.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -4,17 +4,16 @@
|
||||||
:response: PreviewDataFrameTransformResponse
|
:response: PreviewDataFrameTransformResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Preview Data Frame Transform API
|
=== Preview {dataframe-transform} API
|
||||||
|
|
||||||
The Preview Data Frame Transform API is used to preview the results of
|
Previews the results of a {dataframe-transform}.
|
||||||
a {dataframe-transform}.
|
|
||||||
|
|
||||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Preview Data Frame Request
|
==== Preview {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ takes a single argument: a valid data frame transform config.
|
A +{request}+ takes a single argument: a valid {dataframe-transform} config.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -22,7 +21,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> The source config from which the data should be gathered
|
<1> The source config from which the data should be gathered
|
||||||
<2> The pivot config used to transform the data
|
<2> The pivot config used to transform the data
|
||||||
<3> The configuration of the {dataframe-job} to preview
|
<3> The configuration of the {dataframe-transform} to preview
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
|
|
|
@ -4,14 +4,14 @@
|
||||||
:response: AcknowledgedResponse
|
:response: AcknowledgedResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Data Frame Transform API
|
=== Put {dataframe-transform} API
|
||||||
|
|
||||||
The Put Data Frame Transform API is used to create a new {dataframe-transform}.
|
Creates a new {dataframe-transform}.
|
||||||
|
|
||||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Data Frame Request
|
==== Put {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
@ -26,10 +26,10 @@ with the privileges of the user creating it. Meaning, if they do not have privil
|
||||||
such an error will not be visible until `_start` is called.
|
such an error will not be visible until `_start` is called.
|
||||||
|
|
||||||
[id="{upid}-{api}-config"]
|
[id="{upid}-{api}-config"]
|
||||||
==== Data Frame Transform Configuration
|
==== {dataframe-transform-cap} configuration
|
||||||
|
|
||||||
The `DataFrameTransformConfig` object contains all the details about the {dataframe-transform}
|
The `DataFrameTransformConfig` object contains all the details about the
|
||||||
configuration and contains the following arguments:
|
{dataframe-transform} configuration and contains the following arguments:
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -4,13 +4,13 @@
|
||||||
:response: StartDataFrameTransformResponse
|
:response: StartDataFrameTransformResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Start Data Frame Transform API
|
=== Start {dataframe-transform} API
|
||||||
|
|
||||||
Start a {dataframe-job}.
|
Starts a {dataframe-transform}.
|
||||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Start Data Frame Request
|
==== Start {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ object requires a non-null `id`.
|
A +{request}+ object requires a non-null `id`.
|
||||||
|
|
||||||
|
@ -18,9 +18,10 @@ A +{request}+ object requires a non-null `id`.
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request]
|
include-tagged::{doc-tests-file}[{api}-request]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
<1> Constructing a new start request referencing an existing {dataframe-job}
|
<1> Constructing a new start request referencing an existing
|
||||||
|
{dataframe-transform}
|
||||||
|
|
||||||
==== Optional Arguments
|
==== Optional arguments
|
||||||
|
|
||||||
The following arguments are optional.
|
The following arguments are optional.
|
||||||
|
|
||||||
|
@ -28,10 +29,11 @@ The following arguments are optional.
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request-options]
|
include-tagged::{doc-tests-file}[{api}-request-options]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> Controls the amount of time to wait until the {dataframe-job} starts.
|
<1> Controls the amount of time to wait until the {dataframe-transform} starts.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ object acknowledges the {dataframe-job} has started.
|
The returned +{response}+ object acknowledges the {dataframe-transform} has
|
||||||
|
started.
|
|
@ -4,25 +4,25 @@
|
||||||
:response: StopDataFrameTransformResponse
|
:response: StopDataFrameTransformResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Stop Data Frame Transform API
|
=== Stop {dataframe-transform} API
|
||||||
|
|
||||||
Stop a started {dataframe-job}.
|
Stops a started {dataframe-transform}.
|
||||||
It accepts a +{request}+ object and responds with a +{response}+ object.
|
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Stop Data Frame Request
|
==== Stop {dataframe-transform} request
|
||||||
|
|
||||||
A +{request}+ object requires a non-null `id`. `id` can be a comma separated list of Ids
|
A +{request}+ object requires a non-null `id`. `id` can be a comma separated
|
||||||
or a single Id. Wildcards, `*` and `_all` are also accepted.
|
list of IDs or a single ID. Wildcards, `*` and `_all` are also accepted.
|
||||||
|
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request]
|
include-tagged::{doc-tests-file}[{api}-request]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
<1> Constructing a new stop request referencing an existing {dataframe-job}
|
<1> Constructing a new stop request referencing an existing {dataframe-transform}
|
||||||
|
|
||||||
==== Optional Arguments
|
==== Optional arguments
|
||||||
|
|
||||||
The following arguments are optional.
|
The following arguments are optional.
|
||||||
|
|
||||||
|
@ -31,11 +31,11 @@ The following arguments are optional.
|
||||||
include-tagged::{doc-tests-file}[{api}-request-options]
|
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 data frame task to stop before responding
|
||||||
<2> Controls the amount of time to wait until the {dataframe-job} stops.
|
<2> Controls the amount of time to wait until the {dataframe-transform} stops.
|
||||||
<3> Whether to ignore if a wildcard expression matches no transforms.
|
<3> Whether to ignore if a wildcard expression matches no transforms.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ object acknowledges the {dataframe-job} has stopped.
|
The returned +{response}+ object acknowledges the {dataframe-transform} has stopped.
|
|
@ -5,7 +5,7 @@ For methods with requests, see execution.asciidoc
|
||||||
////
|
////
|
||||||
|
|
||||||
[id="{upid}-{api}-sync"]
|
[id="{upid}-{api}-sync"]
|
||||||
==== Synchronous Execution
|
==== Synchronous execution
|
||||||
|
|
||||||
When executing the +{api}+ API in the following manner, the client waits
|
When executing the +{api}+ API in the following manner, the client waits
|
||||||
for the +{response}+ to be returned before continuing with code execution:
|
for the +{response}+ to be returned before continuing with code execution:
|
||||||
|
@ -25,7 +25,7 @@ a generic `ElasticsearchException` and adds the original `ResponseException` as
|
||||||
suppressed exception to it.
|
suppressed exception to it.
|
||||||
|
|
||||||
[id="{upid}-{api}-async"]
|
[id="{upid}-{api}-async"]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous execution
|
||||||
|
|
||||||
The +{api}+ API can also be called in an asynchronous fashion so that
|
The +{api}+ API can also be called in an asynchronous fashion so that
|
||||||
the client can return directly. Users need to specify how the response or
|
the client can return directly. Users need to specify how the response or
|
||||||
|
|
|
@ -8,7 +8,7 @@ test.
|
||||||
////
|
////
|
||||||
|
|
||||||
[id="{upid}-{api}-sync"]
|
[id="{upid}-{api}-sync"]
|
||||||
==== Synchronous Execution
|
==== Synchronous execution
|
||||||
|
|
||||||
When executing a +{request}+ in the following manner, the client waits
|
When executing a +{request}+ in the following manner, the client waits
|
||||||
for the +{response}+ to be returned before continuing with code execution:
|
for the +{response}+ to be returned before continuing with code execution:
|
||||||
|
@ -28,7 +28,7 @@ a generic `ElasticsearchException` and adds the original `ResponseException` as
|
||||||
suppressed exception to it.
|
suppressed exception to it.
|
||||||
|
|
||||||
[id="{upid}-{api}-async"]
|
[id="{upid}-{api}-async"]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous execution
|
||||||
|
|
||||||
Executing a +{request}+ can also be done in an asynchronous fashion so that
|
Executing a +{request}+ can also be done in an asynchronous fashion so that
|
||||||
the client can return directly. Users need to specify how the response or
|
the client can return directly. Users need to specify how the response or
|
||||||
|
|
|
@ -27,9 +27,8 @@ The following arguments are optional:
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request-force]
|
include-tagged::{doc-tests-file}[{api}-request-force]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
<1> Use to forcefully delete an opened job;
|
<1> Use to forcefully delete an opened job. This method is quicker than closing
|
||||||
this method is quicker than closing and deleting the job.
|
and deleting the job. Defaults to `false`.
|
||||||
Defaults to `false`.
|
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
|
@ -50,9 +49,9 @@ for completion:
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
<1> whether was job deletion was acknowledged or not; will be `null` when set
|
<1> Whether job deletion was acknowledged or not. It will be `null` when set
|
||||||
not to wait for completion
|
to not wait for completion.
|
||||||
<2> the id of the job deletion task; will be `null` when set to wait for
|
<2> The ID of the job deletion task. It will be `null` when set to wait for
|
||||||
completion
|
completion.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
|
@ -564,12 +564,14 @@ include::ilm/lifecycle_management_status.asciidoc[]
|
||||||
include::ilm/retry_lifecycle_policy.asciidoc[]
|
include::ilm/retry_lifecycle_policy.asciidoc[]
|
||||||
include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
|
include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
|
||||||
|
|
||||||
== Data Frame APIs
|
[[_data_frame_transform_apis]]
|
||||||
|
== {dataframe-transform-cap} APIs
|
||||||
|
|
||||||
:upid: {mainid}-dataframe
|
:upid: {mainid}-dataframe
|
||||||
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
|
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
|
||||||
|
|
||||||
The Java High Level REST Client supports the following Data Frame APIs:
|
The Java High Level REST Client supports the following {dataframe-transform}
|
||||||
|
APIs:
|
||||||
|
|
||||||
* <<{upid}-get-data-frame-transform>>
|
* <<{upid}-get-data-frame-transform>>
|
||||||
* <<{upid}-get-data-frame-transform-stats>>
|
* <<{upid}-get-data-frame-transform-stats>>
|
||||||
|
|
Loading…
Reference in New Issue