Get transform API
editGet transform API
editRetrieves configuration information about one or more transforms.
The API accepts a GetTransformRequest
object and returns a GetTransformResponse
.
Get transform request
editA GetTransformRequest
requires either a transform ID, a comma separated list
of ids or the special wildcard _all
to get all transforms.
Optional arguments
editThe following arguments are optional.
request.setPageParams(new PageParams(0, 100)); request.setAllowNoMatch(true); request.setExcludeGenerated(false);
The page parameters |
|
Whether to ignore if a wildcard expression matches no transforms. |
|
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. |
Synchronous execution
editWhen executing a GetTransformRequest
in the following manner, the client waits
for the GetTransformResponse
to be returned before continuing with code execution:
GetTransformResponse response = client.transform() .getTransform(request, RequestOptions.DEFAULT);
Synchronous calls may throw an IOException
in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a 4xx
or 5xx
error code, the high-level
client tries to parse the response body error details instead and then throws
a generic ElasticsearchException
and adds the original ResponseException
as a
suppressed exception to it.
Asynchronous execution
editExecuting a GetTransformRequest
can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous get-transform method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for get-transform
looks like:
Response
editThe returned GetTransformResponse
contains the requested transforms.
List<TransformConfig> transformConfigs = response.getTransformConfigurations();