OpenSearch/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc

--
:api: get-data-frame-transform
:request: GetDataFrameTransformRequest
:response: GetDataFrameTransformResponse
--
[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}.


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]
--------------------------------------------------