Package co.elastic.clients.elasticsearch.ml

Class DeleteTrainedModelRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteTrainedModelRequest

public class DeleteTrainedModelRequest
extends RequestBase

Delete an unreferenced trained model.

The request deletes a trained inference model that is not referenced by an ingest pipeline.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteTrainedModelRequest.Builder	Builder for DeleteTrainedModelRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<DeleteTrainedModelRequest,DeleteTrainedModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.delete_trained_model".

Method Summary

Modifier and Type	Method	Description
final Boolean	force()	Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.
final String	modelId()	Required - The unique identifier of the trained model.
static DeleteTrainedModelRequest	of(Function<DeleteTrainedModelRequest.Builder,ObjectBuilder<DeleteTrainedModelRequest>> fn)
final Time	timeout()	Period to wait for a response.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<DeleteTrainedModelRequest,DeleteTrainedModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.delete_trained_model".

Method Details

of

public static DeleteTrainedModelRequest of(Function<DeleteTrainedModelRequest.Builder,ObjectBuilder<DeleteTrainedModelRequest>> fn)

force

@Nullable
public final Boolean force()

Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.

API name: force

modelId

public final String modelId()

Required - The unique identifier of the trained model.

API name: model_id

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout