Package co.elastic.clients.elasticsearch.inference

Class DeleteInferenceRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteInferenceRequest.Builder>

co.elastic.clients.elasticsearch.inference.DeleteInferenceRequest.Builder

All Implemented Interfaces:

WithJson<DeleteInferenceRequest.Builder>, ObjectBuilder<DeleteInferenceRequest>

Enclosing class:

DeleteInferenceRequest

public static class DeleteInferenceRequest.Builder
extends RequestBase.AbstractBuilder<DeleteInferenceRequest.Builder>
implements ObjectBuilder<DeleteInferenceRequest>

Builder for DeleteInferenceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteInferenceRequest	build()	Builds a DeleteInferenceRequest.
final DeleteInferenceRequest.Builder	dryRun(Boolean value)	When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.
final DeleteInferenceRequest.Builder	force(Boolean value)	When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.
final DeleteInferenceRequest.Builder	inferenceId(String value)	Required - The inference identifier.
protected DeleteInferenceRequest.Builder	self()
final DeleteInferenceRequest.Builder	taskType(TaskType value)	The task type

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dryRun

public final DeleteInferenceRequest.Builder dryRun(@Nullable
 Boolean value)

When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.

API name: dry_run

force

public final DeleteInferenceRequest.Builder force(@Nullable
 Boolean value)

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 DeleteInferenceRequest.Builder inferenceId(String value)

Required - The inference identifier.

API name: inference_id

taskType

public final DeleteInferenceRequest.Builder taskType(@Nullable
 TaskType value)

The task type

API name: task_type

self

protected DeleteInferenceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteInferenceRequest.Builder>

build

public DeleteInferenceRequest build()

Builds a DeleteInferenceRequest.

Specified by:

build in interface ObjectBuilder<DeleteInferenceRequest>

Throws:

NullPointerException - if some of the required fields are null.