1
2
3[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespace]]
4=== Elasticsearch\Namespaces\DataFrameTransformDeprecatedNamespace
5
6
7
8Class DataFrameTransformDeprecatedNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacedeleteTransform_deleteTransform,`deleteTransform()`>>
22* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacegetTransform_getTransform,`getTransform()`>>
23* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacegetTransformStats_getTransformStats,`getTransformStats()`>>
24* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacepreviewTransform_previewTransform,`previewTransform()`>>
25* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespaceputTransform_putTransform,`putTransform()`>>
26* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacestartTransform_startTransform,`startTransform()`>>
27* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacestopTransform_stopTransform,`stopTransform()`>>
28* <<Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespaceupdateTransform_updateTransform,`updateTransform()`>>
29
30
31
32[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacedeleteTransform_deleteTransform]]
33.`deleteTransform(array $params = [])`
34*NOTE:* This API is BETA and may change in ways that are not backwards compatible
35****
36[source,php]
37----
38/*
39$params['transform_id'] = (string) The id of the transform to delete
40$params['force']        = (boolean) When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
41*/
42----
43****
44
45
46
47[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacegetTransform_getTransform]]
48.`getTransform(array $params = [])`
49*NOTE:* This API is BETA and may change in ways that are not backwards compatible
50****
51[source,php]
52----
53/*
54$params['transform_id']      = (string) The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
55$params['from']              = (int) skips a number of transform configs, defaults to 0
56$params['size']              = (int) specifies a max number of transforms to get, defaults to 100
57$params['allow_no_match']    = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
58$params['exclude_generated'] = (boolean) Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster (Default = false)
59*/
60----
61****
62
63
64
65[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacegetTransformStats_getTransformStats]]
66.`getTransformStats(array $params = [])`
67*NOTE:* This API is BETA and may change in ways that are not backwards compatible
68****
69[source,php]
70----
71/*
72$params['transform_id']   = (string) The id of the transform for which to get stats. '_all' or '*' implies all transforms
73$params['from']           = (number) skips a number of transform stats, defaults to 0
74$params['size']           = (number) specifies a max number of transform stats to get, defaults to 100
75$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
76*/
77----
78****
79
80
81
82[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacepreviewTransform_previewTransform]]
83.`previewTransform(array $params = [])`
84****
85[source,php]
86----
87/*
88*/
89----
90****
91
92
93
94[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespaceputTransform_putTransform]]
95.`putTransform(array $params = [])`
96*NOTE:* This API is BETA and may change in ways that are not backwards compatible
97****
98[source,php]
99----
100/*
101$params['transform_id']     = (string) The id of the new transform.
102*/
103----
104****
105
106
107
108[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacestartTransform_startTransform]]
109.`startTransform(array $params = [])`
110*NOTE:* This API is BETA and may change in ways that are not backwards compatible
111****
112[source,php]
113----
114/*
115$params['transform_id'] = (string) The id of the transform to start
116$params['timeout']      = (time) Controls the time to wait for the transform to start
117*/
118----
119****
120
121
122
123[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespacestopTransform_stopTransform]]
124.`stopTransform(array $params = [])`
125*NOTE:* This API is BETA and may change in ways that are not backwards compatible
126****
127[source,php]
128----
129/*
130$params['transform_id']        = (string) The id of the transform to stop
131$params['wait_for_completion'] = (boolean) Whether to wait for the transform to fully stop before returning or not. Default to false
132$params['timeout']             = (time) Controls the time to wait until the transform has stopped. Default to 30 seconds
133$params['allow_no_match']      = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
134*/
135----
136****
137
138
139
140[[Elasticsearch_Namespaces_DataFrameTransformDeprecatedNamespaceupdateTransform_updateTransform]]
141.`updateTransform(array $params = [])`
142*NOTE:* This API is BETA and may change in ways that are not backwards compatible
143****
144[source,php]
145----
146/*
147$params['transform_id']     = (string) The id of the transform.
148*/
149----
150****
151
152
153