Package co.elastic.clients.elasticsearch.inference

Class PutElasticsearchRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.PutElasticsearchRequest.Builder

All Implemented Interfaces:

WithJson<PutElasticsearchRequest.Builder>, ObjectBuilder<PutElasticsearchRequest>

Enclosing class:

PutElasticsearchRequest

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

Builder for PutElasticsearchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutElasticsearchRequest	build()	Builds a PutElasticsearchRequest.
final PutElasticsearchRequest.Builder	chunkingSettings(InferenceChunkingSettings value)	The chunking configuration object.
final PutElasticsearchRequest.Builder	chunkingSettings(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)	The chunking configuration object.
final PutElasticsearchRequest.Builder	elasticsearchInferenceId(String value)	Required - The unique identifier of the inference endpoint.
protected PutElasticsearchRequest.Builder	self()
final PutElasticsearchRequest.Builder	service(ElasticsearchServiceType value)	Required - The type of service supported for the specified task type.
final PutElasticsearchRequest.Builder	serviceSettings(ElasticsearchServiceSettings value)	Required - Settings used to install the inference model.
final PutElasticsearchRequest.Builder	serviceSettings(Function<ElasticsearchServiceSettings.Builder,ObjectBuilder<ElasticsearchServiceSettings>> fn)	Required - Settings used to install the inference model.
final PutElasticsearchRequest.Builder	taskSettings(ElasticsearchTaskSettings value)	Settings to configure the inference task.
final PutElasticsearchRequest.Builder	taskSettings(Function<ElasticsearchTaskSettings.Builder,ObjectBuilder<ElasticsearchTaskSettings>> fn)	Settings to configure the inference task.
final PutElasticsearchRequest.Builder	taskType(ElasticsearchTaskType value)	Required - The type of the inference task that the model will perform.
final PutElasticsearchRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference endpoint to be created.
final PutElasticsearchRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies the amount of time to wait for the inference endpoint to be created.

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

chunkingSettings

public final PutElasticsearchRequest.Builder chunkingSettings(@Nullable
 InferenceChunkingSettings value)

The chunking configuration object.

API name: chunking_settings

chunkingSettings

public final PutElasticsearchRequest.Builder chunkingSettings(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)

The chunking configuration object.

API name: chunking_settings

elasticsearchInferenceId

public final PutElasticsearchRequest.Builder elasticsearchInferenceId(String value)

Required - The unique identifier of the inference endpoint. The must not match the model_id.

API name: elasticsearch_inference_id

service

public final PutElasticsearchRequest.Builder service(ElasticsearchServiceType value)

Required - The type of service supported for the specified task type. In this case, elasticsearch.

API name: service

serviceSettings

public final PutElasticsearchRequest.Builder serviceSettings(ElasticsearchServiceSettings value)

Required - Settings used to install the inference model. These settings are specific to the elasticsearch service.

API name: service_settings

serviceSettings

public final PutElasticsearchRequest.Builder serviceSettings(Function<ElasticsearchServiceSettings.Builder,ObjectBuilder<ElasticsearchServiceSettings>> fn)

Required - Settings used to install the inference model. These settings are specific to the elasticsearch service.

API name: service_settings

taskSettings

public final PutElasticsearchRequest.Builder taskSettings(@Nullable
 ElasticsearchTaskSettings value)

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskSettings

public final PutElasticsearchRequest.Builder taskSettings(Function<ElasticsearchTaskSettings.Builder,ObjectBuilder<ElasticsearchTaskSettings>> fn)

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskType

public final PutElasticsearchRequest.Builder taskType(ElasticsearchTaskType value)

Required - The type of the inference task that the model will perform.

API name: task_type

timeout

public final PutElasticsearchRequest.Builder timeout(@Nullable
 Time value)

Specifies the amount of time to wait for the inference endpoint to be created.

API name: timeout

timeout

public final PutElasticsearchRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specifies the amount of time to wait for the inference endpoint to be created.

API name: timeout

self

protected PutElasticsearchRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutElasticsearchRequest.Builder>

build

public PutElasticsearchRequest build()

Builds a PutElasticsearchRequest.

Specified by:

build in interface ObjectBuilder<PutElasticsearchRequest>

Throws:

NullPointerException - if some of the required fields are null.