@@ -41,15 +41,15 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
41
41
==== {api-path-parms-title}
42
42
43
43
`<data_frame_transform_id>`::
44
- (string) Required. Identifier for the {dataframe-transform}. This identifier
44
+ (Required, string) Identifier for the {dataframe-transform}. This identifier
45
45
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
46
46
underscores. It must start and end with alphanumeric characters.
47
47
48
48
[[put-data-frame-transform-request-body]]
49
49
==== {api-request-body-title}
50
50
51
51
`description`::
52
- (string) Optional. Free text description of the {dataframe-transform}.
52
+ (Optional, string) Free text description of the {dataframe-transform}.
53
53
54
54
`dest`::
55
55
(Required, object) Required. The destination configuration, which has the
@@ -59,12 +59,22 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
59
59
(Required, string) The _destination index_ for the {dataframe-transform}.
60
60
61
61
`pivot`::
62
- (object) Required. Defines the pivot function `group by` fields and the
62
+ (Required, object) Defines the pivot function `group by` fields and the
63
63
aggregation to reduce the data. See <<data-frame-transform-pivot>>.
64
64
65
65
`source`::
66
- (object) Required. The source configuration, which consists of `index` and
67
- optionally a `query`. See <<data-frame-transform-source>>.
66
+ (Required, object) The source configuration, which has the following
67
+ properties:
68
+
69
+ `index`:::
70
+ (Required, string or array) The _source indices_ for the
71
+ {dataframe-transform}. It can be a single index, an index pattern (for
72
+ example, `"myindex*"`), or an array of indices (for example,
73
+ `["index1", "index2"]`).
74
+
75
+ `query`:::
76
+ (Optional, object) A query clause that retrieves a subset of data from the
77
+ source index. See <<query-dsl>>.
68
78
69
79
[[put-data-frame-transform-example]]
70
80
==== {api-examples-title}
0 commit comments