Package co.elastic.clients.elasticsearch.inference

Class DeleteInferenceRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.DeleteInferenceRequest

public class DeleteInferenceRequest
extends RequestBase

Delete an inference endpoint This API requires the manage_inference cluster privilege (the built-in inference_admin role grants this privilege).

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteInferenceRequest,DeleteInferenceResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.delete".

Method Summary

Modifier and Type	Method	Description
final Boolean	dryRun()	When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.
final Boolean	force()	When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.
final String	inferenceId()	Required - The inference identifier.
static DeleteInferenceRequest	of(Function<DeleteInferenceRequest.Builder,ObjectBuilder<DeleteInferenceRequest>> fn)
final TaskType	taskType()	The task type

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<DeleteInferenceRequest,DeleteInferenceResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.delete".

Method Details

of

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

dryRun

@Nullable
public final Boolean dryRun()

When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.

API name: dry_run

force

@Nullable
public final Boolean force()

When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.

API name: force

inferenceId

public final String inferenceId()

Required - The inference identifier.

API name: inference_id

taskType

@Nullable
public final TaskType taskType()

The task type

API name: task_type