Delete trained model alias API

Deletes a trained model alias. The API accepts a DeleteTrainedModelAliasRequest object as a request and returns a AcknowledgedResponse. If the model alias is not assigned to the provided model id, or if the model alias does not exist, this API will result in an error.

Delete trained model alias request

edit

A DeleteTrainedModelAliasRequest requires the following arguments:

DeleteTrainedModelAliasRequest request = new DeleteTrainedModelAliasRequest(
    "my-alias-to-delete", 
    "my-trained-model-with-delete-alias" 
);

	The trained model alias to delete
	The trained model id to which model alias is assigned

Synchronous execution

edit

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

AcknowledgedResponse response =
    client.machineLearning().deleteTrainedModelAlias(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 DeleteTrainedModelAliasRequest 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 delete-trained-model-alias method:

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

The DeleteTrainedModelAliasRequest 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 delete-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 `DeleteTrainedModelAliasRequest` fails.

Response

edit

The returned AcknowledgedResponse

boolean acknowledged = response.isAcknowledged();

« Delete trained models API Estimate anomaly detection job model memory API »