honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc

104 lines
3.2 KiB
Plaintext
Raw Normal View History

[ML-Dataframe] Add Data Frame client to the Java HLRC (#40040) Adds DataFrameClient to the Java HLRC and implements PUT and DELETE data frame transform.
2019-03-14 10:57:12 -04:00
--
:api: put-data-frame-transform
:request: PutDataFrameTransformRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Put Data Frame Transform API
The Put Data Frame Transform API is used to create a new {dataframe-transform}.
The API accepts a +{request}+ object as a request and returns a +{response}+.
[id="{upid}-{api}-request"]
==== Put Data Frame 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-job} to create
[id="{upid}-{api}-config"]
==== Data Frame Transform Configuration
The `DataFrameTransformConfig` object contains all the details about the {dataframe-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
[ML] make source and dest objects in the transform config (#40337) (#40396) * [ML] make source and dest objects in the transform config * addressing PR comments * Fixing compilation post merge * adding comment for Arrays.hashCode * addressing changes for moving dest to object * fixing data_frame yml tests * fixing API test
2019-03-25 08:16:41 -04:00
<2> The source indices and query from which to gather data
[ML-Dataframe] Add Data Frame client to the Java HLRC (#40040) Adds DataFrameClient to the Java HLRC and implements PUT and DELETE data frame transform.
2019-03-14 10:57:12 -04:00
<3> The destination index
[ML] make source and dest objects in the transform config (#40337) (#40396) * [ML] make source and dest objects in the transform config * addressing PR comments * Fixing compilation post merge * adding comment for Arrays.hashCode * addressing changes for moving dest to object * fixing data_frame yml tests * fixing API test
2019-03-25 08:16:41 -04:00
<4> The PivotConfig
[ML] cleanup + adding description field to transforms (#41554) (#41605) * [ML] cleanup + adding description field to transforms * making description length have a max of 1k
2019-04-26 17:50:59 -04:00
<5> Optional free text description of the transform
[ML-Dataframe] Add Data Frame client to the Java HLRC (#40040) Adds DataFrameClient to the Java HLRC and implements PUT and DELETE data frame transform.
2019-03-14 10:57:12 -04:00
[id="{upid}-{api}-query-config"]
[ML] make source and dest objects in the transform config (#40337) (#40396) * [ML] make source and dest objects in the transform config * addressing PR comments * Fixing compilation post merge * adding comment for Arrays.hashCode * addressing changes for moving dest to object * fixing data_frame yml tests * fixing API test
2019-03-25 08:16:41 -04:00
==== SourceConfig
The indices and the query from which to collect data.
If query is not set, a `match_all` query is used by default.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-source-config]
--------------------------------------------------
===== QueryConfig
[ML-Dataframe] Add Data Frame client to the Java HLRC (#40040) Adds DataFrameClient to the Java HLRC and implements PUT and DELETE data frame transform.
2019-03-14 10:57:12 -04:00
The query with which to select data from the source.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-query-config]
--------------------------------------------------
==== PivotConfig
Defines the pivot function `group by` fields and the aggregation to reduce the data.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-pivot-config]
--------------------------------------------------
===== GroupConfig
The grouping terms. Defines the group by and destination fields
which are produced by the pivot function. There are 3 types of
groups
* Terms
* Histogram
* Date Histogram
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-group-config]
--------------------------------------------------
<1> The destination field
<2> Group by values of the `user_id` field
===== AggregationConfig
Defines the aggregations for the group fields.
// TODO link to the supported aggregations
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-agg-config]
--------------------------------------------------
<1> Aggregate the average star rating
include::../execution.asciidoc[]
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ acknowledges the successful creation of
the new {dataframe-transform} or an error if the configuration is invalid.