Put Filter API
editPut Filter API
editThe Put Filter API can be used to create a new machine learning filter
in the cluster. The API accepts a PutFilterRequest
object
as a request and returns a PutFilterResponse
.
Put Filter Request
editA PutFilterRequest
requires the following argument:
Filter Configuration
editThe MlFilter
object contains all the details about the machine learning filter
configuration.
A MlFilter
contains the following arguments:
Synchronous execution
editWhen executing a PutFilterRequest
in the following manner, the client waits
for the PutFilterResponse
to be returned before continuing with code execution:
PutFilterResponse response = client.machineLearning().putFilter(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 PutFilterRequest
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 put-filter 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 put-filter
looks like:
Response
editThe returned PutFilterResponse
returns the full representation of
the new machine learning filter if it has been successfully created.