mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-27 00:27:25 -04:00
ebcac2d864
This adds a new flag `exclude_generated` for GET transform API. This flag is useful for when a transform needs to be cloned within a cluster or exported/imported between clusters. It removes certain fields that are not able to be set via the PUT api (e.g. version, create_time). relates https://github.com/elastic/elasticsearch/issues/63055
52 lines
1.8 KiB
Text
52 lines
1.8 KiB
Text
--
|
|
:api: get-transform
|
|
:request: GetTransformRequest
|
|
:response: GetTransformResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Get {transform} API
|
|
|
|
Retrieves configuration information about one or more {transforms}.
|
|
The API accepts a +{request}+ object and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Get {transform} request
|
|
|
|
A +{request}+ requires either a {transform} ID, a comma separated list
|
|
of ids or the special wildcard `_all` to get all {transforms}.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> Constructing a new GET request referencing an existing {transform}
|
|
|
|
==== Optional arguments
|
|
|
|
The following arguments are optional.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request-options]
|
|
--------------------------------------------------
|
|
<1> The page parameters `from` and `size`. `from` specifies the number of
|
|
{transforms} to skip. `size` specifies the maximum number of
|
|
{transforms} to get. Defaults to `0` and `100` respectively.
|
|
<2> Whether to ignore if a wildcard expression matches no {transforms}.
|
|
<3> Optional boolean value for requesting the {transform} in a format that can
|
|
then be put into another cluster. Certain fields that can only be set when
|
|
the {transform} is created are removed.
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ contains the requested {transforms}.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|