Package co.elastic.clients.elasticsearch.ml

Class PutTrainedModelRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<PutTrainedModelRequest.Builder>

co.elastic.clients.elasticsearch.ml.PutTrainedModelRequest.Builder

All Implemented Interfaces:

WithJson<PutTrainedModelRequest.Builder>, ObjectBuilder<PutTrainedModelRequest>

Enclosing class:

PutTrainedModelRequest

public static class PutTrainedModelRequest.Builder
extends WithJsonObjectBuilderBase<PutTrainedModelRequest.Builder>
implements ObjectBuilder<PutTrainedModelRequest>

Builder for PutTrainedModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutTrainedModelRequest	build()	Builds a PutTrainedModelRequest.
PutTrainedModelRequest.Builder	compressedDefinition(java.lang.String value)	The compressed (GZipped and Base64 encoded) inference definition of the model.
PutTrainedModelRequest.Builder	deferDefinitionDecompression(java.lang.Boolean value)	If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations.
PutTrainedModelRequest.Builder	definition(Definition value)	The inference definition for the model.
PutTrainedModelRequest.Builder	definition(java.util.function.Function<Definition.Builder,ObjectBuilder<Definition>> fn)	The inference definition for the model.
PutTrainedModelRequest.Builder	description(java.lang.String value)	A human-readable description of the inference trained model.
PutTrainedModelRequest.Builder	inferenceConfig(InferenceConfigCreate value)	Required - The default configuration for inference.
PutTrainedModelRequest.Builder	inferenceConfig(java.util.function.Function<InferenceConfigCreate.Builder,ObjectBuilder<InferenceConfigCreate>> fn)	Required - The default configuration for inference.
PutTrainedModelRequest.Builder	input(Input value)	Required - The input field names for the model definition.
PutTrainedModelRequest.Builder	input(java.util.function.Function<Input.Builder,ObjectBuilder<Input>> fn)	Required - The input field names for the model definition.
PutTrainedModelRequest.Builder	metadata(JsonData value)	An object map that contains metadata about the model.
PutTrainedModelRequest.Builder	modelId(java.lang.String value)	Required - The unique identifier of the trained model.
PutTrainedModelRequest.Builder	modelSizeBytes(java.lang.Long value)	The estimated memory usage in bytes to keep the trained model in memory.
PutTrainedModelRequest.Builder	modelType(TrainedModelType value)	The model type.
protected PutTrainedModelRequest.Builder	self()
PutTrainedModelRequest.Builder	tags(java.lang.String value, java.lang.String... values)	An array of tags to organize the model.
PutTrainedModelRequest.Builder	tags(java.util.List<java.lang.String> list)	An array of tags to organize the model.

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

compressedDefinition

public final PutTrainedModelRequest.Builder compressedDefinition(@Nullable
java.lang.String value)

The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.

API name: compressed_definition

deferDefinitionDecompression

public final PutTrainedModelRequest.Builder deferDefinitionDecompression(@Nullable
java.lang.Boolean value)

If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations.

API name: defer_definition_decompression

definition

public final PutTrainedModelRequest.Builder definition(@Nullable
Definition value)

The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.

API name: definition

definition

public final PutTrainedModelRequest.Builder definition(java.util.function.Function<Definition.Builder,ObjectBuilder<Definition>> fn)

The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.

API name: definition

description

public final PutTrainedModelRequest.Builder description(@Nullable
java.lang.String value)

A human-readable description of the inference trained model.

API name: description

inferenceConfig

public final PutTrainedModelRequest.Builder inferenceConfig(InferenceConfigCreate value)

Required - The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.

API name: inference_config

inferenceConfig

public final PutTrainedModelRequest.Builder inferenceConfig(java.util.function.Function<InferenceConfigCreate.Builder,ObjectBuilder<InferenceConfigCreate>> fn)

Required - The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.

API name: inference_config

input

public final PutTrainedModelRequest.Builder input(Input value)

Required - The input field names for the model definition.

API name: input

input

public final PutTrainedModelRequest.Builder input(java.util.function.Function<Input.Builder,ObjectBuilder<Input>> fn)

Required - The input field names for the model definition.

API name: input

metadata

public final PutTrainedModelRequest.Builder metadata(@Nullable
JsonData value)

An object map that contains metadata about the model.

API name: metadata

modelId

public final PutTrainedModelRequest.Builder modelId(java.lang.String value)

Required - The unique identifier of the trained model.

API name: model_id

modelSizeBytes

public final PutTrainedModelRequest.Builder modelSizeBytes(@Nullable
java.lang.Long value)

The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.

API name: model_size_bytes

modelType

public final PutTrainedModelRequest.Builder modelType(@Nullable
TrainedModelType value)

The model type.

API name: model_type

tags

public final PutTrainedModelRequest.Builder tags(java.util.List<java.lang.String> list)

An array of tags to organize the model.

API name: tags

Adds all elements of list to tags.

tags

public final PutTrainedModelRequest.Builder tags(java.lang.String value,
java.lang.String... values)

An array of tags to organize the model.

API name: tags

Adds one or more values to tags.

self

protected PutTrainedModelRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<PutTrainedModelRequest.Builder>

build

public PutTrainedModelRequest build()

Builds a PutTrainedModelRequest.

Specified by:

build in interface ObjectBuilder<PutTrainedModelRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.