Package co.elastic.clients.elasticsearch.inference

Class PutRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.PutRequest.Builder

All Implemented Interfaces:

WithJson<PutRequest.Builder>, ObjectBuilder<PutRequest>

Enclosing class:

PutRequest

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

Builder for PutRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutRequest	build()	Builds a PutRequest.
final PutRequest.Builder	inferenceConfig(InferenceEndpoint value)	Required - Request body.
final PutRequest.Builder	inferenceConfig(Function<InferenceEndpoint.Builder,ObjectBuilder<InferenceEndpoint>> fn)	Required - Request body.
final PutRequest.Builder	inferenceId(String value)	Required - The inference Id
protected PutRequest.Builder	self()
final PutRequest.Builder	taskType(TaskType value)	The task type.
final PutRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference endpoint to be created.
final PutRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies the amount of time to wait for the inference endpoint to be created.
PutRequest.Builder	withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)	Sets additional properties values on this object by reading from a JSON input.

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

inferenceId

public final PutRequest.Builder inferenceId(String value)

Required - The inference Id

API name: inference_id

taskType

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

The task type. Refer to the integration list in the API description for the available task types.

API name: task_type

timeout

public final PutRequest.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 PutRequest.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

inferenceConfig

public final PutRequest.Builder inferenceConfig(InferenceEndpoint value)

Required - Request body.

inferenceConfig

public final PutRequest.Builder inferenceConfig(Function<InferenceEndpoint.Builder,ObjectBuilder<InferenceEndpoint>> fn)

Required - Request body.

withJson

public PutRequest.Builder withJson(jakarta.json.stream.JsonParser parser,
 JsonpMapper mapper)

Description copied from interface: WithJson

Sets additional properties values on this object by reading from a JSON input.

This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.

This low level variant of withJson gives full control on the json parser and object mapper. Most of the time using WithJson.withJson(Reader) and WithJson.withJson(InputStream) will be more convenient.

Specified by:

withJson in interface WithJson<PutRequest.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<PutRequest.Builder>

Parameters:

parser - the JSONP parser

mapper - the JSONP mapper used to deserialize values and nested objects

Returns:

this object

self

protected PutRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutRequest.Builder>

build

public PutRequest build()

Builds a PutRequest.

Specified by:

build in interface ObjectBuilder<PutRequest>

Throws:

NullPointerException - if some of the required fields are null.