Package co.elastic.clients.elasticsearch.query_rules

Class PutRulesetRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.query_rules.PutRulesetRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutRulesetRequest
extends RequestBase
implements JsonpSerializable

Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the xpack.applications.rules.max_rules_per_ruleset cluster setting.

IMPORTANT: Due to limitations within pinned queries, you can only select documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutRulesetRequest>	_DESERIALIZER	Json deserializer for PutRulesetRequest
static final Endpoint<PutRulesetRequest,PutRulesetResponse,ErrorResponse>	_ENDPOINT	Endpoint "query_rules.put_ruleset".

Method Summary

Modifier and Type	Method	Description
static PutRulesetRequest	of(Function<PutRulesetRequest.Builder,ObjectBuilder<PutRulesetRequest>> fn)
final List<QueryRule>	rules()	Required - API name: rules
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	setupPutRulesetRequestDeserializer(ObjectDeserializer<PutRulesetRequest.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<PutRulesetRequest> _DESERIALIZER

Json deserializer for PutRulesetRequest

_ENDPOINT

public static final Endpoint<PutRulesetRequest,PutRulesetResponse,ErrorResponse> _ENDPOINT

Endpoint "query_rules.put_ruleset".

Method Details

of

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

rules

public final List<QueryRule> rules()

Required - API name: rules

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)

setupPutRulesetRequestDeserializer

protected static void setupPutRulesetRequestDeserializer(ObjectDeserializer<PutRulesetRequest.Builder> op)