Create or update trained model alias API

Creates or reassigns a trained model alias. The API accepts a PutTrainedModelAliasRequest object as a request and returns a AcknowledgedResponse. The created trained model alias can then be used for other APIs in the stack instead of the referenced model id.

Request

edit

A PutTrainedModelAliasRequest requires the following arguments:

PutTrainedModelAliasRequest request = new PutTrainedModelAliasRequest(
    "my-alias", 
    "my-trained-model-with-alias", 
    false 
);

	The trained model alias to create or reassign
	The trained model id to which to assign the alias
	(Optional) whether or not to reassign the model alias if it is already pointing to a model. Defaults to false.

Synchronous execution

edit

When executing a PutTrainedModelAliasRequest in the following manner, the client waits for the AcknowledgedResponse to be returned before continuing with code execution:

AcknowledgedResponse response =
    client.machineLearning().putTrainedModelAlias(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

edit

Executing a PutTrainedModelAliasRequest 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-trained-model-alias method:

client.machineLearning()
    .putTrainedModelAliasAsync(request, RequestOptions.DEFAULT, listener);

The PutTrainedModelAliasRequest to execute and the ActionListener to use when the execution completes

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-trained-model-alias looks like:

ActionListener<AcknowledgedResponse> listener = new ActionListener<AcknowledgedResponse>() {
    @Override
    public void onResponse(AcknowledgedResponse response) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

	Called when the execution is successfully completed.
	Called when the whole `PutTrainedModelAliasRequest` fails.

Response

edit

The returned AcknowledgedResponse

boolean acknowledged = response.isAcknowledged();

« Create trained models API Reset anomaly detection jobs API »