Package co.elastic.clients.elasticsearch.ml

Class EvaluateDataFrameRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.EvaluateDataFrameRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class EvaluateDataFrameRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<EvaluateDataFrameRequest>	_DESERIALIZER	Json deserializer for EvaluateDataFrameRequest
static Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.evaluate_data_frame".

Constructor Summary

Constructors

Constructor	Description
EvaluateDataFrameRequest(EvaluateDataFrameRequest.Builder builder)
EvaluateDataFrameRequest(java.util.function.Function<EvaluateDataFrameRequest.Builder,EvaluateDataFrameRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
DataframeEvaluation	evaluation()	Required - Defines the type of evaluation you want to perform.
java.lang.String	index()	Required - Defines the index in which the evaluation will be performed.
Query	query()	A query clause that retrieves a subset of data from the source index.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupEvaluateDataFrameRequestDeserializer(DelegatingDeserializer<EvaluateDataFrameRequest.Builder> op)

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<EvaluateDataFrameRequest> _DESERIALIZER

Json deserializer for EvaluateDataFrameRequest

ENDPOINT

public static final Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.evaluate_data_frame".

Constructor Details

EvaluateDataFrameRequest

public EvaluateDataFrameRequest(EvaluateDataFrameRequest.Builder builder)

EvaluateDataFrameRequest

public EvaluateDataFrameRequest(java.util.function.Function<EvaluateDataFrameRequest.Builder,EvaluateDataFrameRequest.Builder> fn)

Method Details

evaluation

public DataframeEvaluation evaluation()

Required - Defines the type of evaluation you want to perform.

API name: evaluation

index

public java.lang.String index()

Required - Defines the index in which the evaluation will be performed.

API name: index

query

@Nullable
public Query query()

A query clause that retrieves a subset of data from the source index.

API name: query

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

setupEvaluateDataFrameRequestDeserializer

protected static void setupEvaluateDataFrameRequestDeserializer(DelegatingDeserializer<EvaluateDataFrameRequest.Builder> op)