2019-03-21 05:38:27 -04:00
|
|
|
--
|
2019-09-20 18:57:43 -04:00
|
|
|
:api: preview-transform
|
2019-09-25 01:38:17 -04:00
|
|
|
:request: PreviewTransformRequest
|
|
|
|
|
:response: PreviewTransformResponse
|
2019-03-21 05:38:27 -04:00
|
|
|
--
|
2019-09-11 14:21:45 -04:00
|
|
|
[role="xpack"]
|
2019-03-21 05:38:27 -04:00
|
|
|
[id="{upid}-{api}"]
|
2019-09-16 11:28:19 -04:00
|
|
|
=== Preview {transform} API
|
2019-03-21 05:38:27 -04:00
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
Previews the results of a {transform}.
|
2019-03-21 05:38:27 -04:00
|
|
|
|
|
|
|
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-09-16 11:28:19 -04:00
|
|
|
==== Preview {transform} request
|
2019-03-21 05:38:27 -04:00
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
A +{request}+ takes a single argument: a valid {transform} config.
|
2019-03-21 05:38:27 -04:00
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
--------------------------------------------------
|
2019-04-26 17:50:59 -04:00
|
|
|
<1> The source config from which the data should be gathered
|
|
|
|
|
<2> The pivot config used to transform the data
|
2019-09-16 11:28:19 -04:00
|
|
|
<3> The configuration of the {transform} to preview
|
2019-03-21 05:38:27 -04:00
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
|
|
==== Response
|
|
|
|
|
|
|
|
|
|
The returned +{response}+ contains the preview documents
|
