Package co.elastic.clients.elasticsearch.query_rules

Class TestRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.query_rules.TestRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TestRequest
extends RequestBase
implements JsonpSerializable

Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<TestRequest>	_DESERIALIZER	Json deserializer for TestRequest
static final Endpoint<TestRequest,TestResponse,ErrorResponse>	_ENDPOINT	Endpoint "query_rules.test".

Method Summary

Modifier and Type	Method	Description
final Map<String,JsonData>	matchCriteria()	Required - The match criteria to apply to rules in the given query ruleset.
static TestRequest	of(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)
final String	rulesetId()	Required - The unique identifier of the query ruleset to be created or updated
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	setupTestRequestDeserializer(ObjectDeserializer<TestRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TestRequest> _DESERIALIZER

Json deserializer for TestRequest

_ENDPOINT

public static final Endpoint<TestRequest,TestResponse,ErrorResponse> _ENDPOINT

Endpoint "query_rules.test".

Method Details

of

public static TestRequest of(Function<TestRequest.Builder,ObjectBuilder<TestRequest>> fn)

matchCriteria

public final Map<String,JsonData> matchCriteria()

Required - The match criteria to apply to rules in the given query ruleset. Match criteria should match the keys defined in the criteria.metadata field of the rule.

API name: match_criteria

rulesetId

public final String rulesetId()

Required - The unique identifier of the query ruleset to be created or updated

API name: ruleset_id

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)

setupTestRequestDeserializer

protected static void setupTestRequestDeserializer(ObjectDeserializer<TestRequest.Builder> op)