Package co.elastic.clients.elasticsearch.query_rules

Class PutRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.query_rules.PutRuleRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutRuleRequest
extends RequestBase
implements JsonpSerializable

Creates or updates a query rule within a query ruleset.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutRuleRequest>	_DESERIALIZER	Json deserializer for PutRuleRequest
static final Endpoint<PutRuleRequest,PutRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "query_rules.put_rule".

Method Summary

Modifier and Type	Method	Description
final QueryRuleActions	actions()	Required - API name: actions
final List<QueryRuleCriteria>	criteria()	Required - API name: criteria
static PutRuleRequest	of(Function<PutRuleRequest.Builder,ObjectBuilder<PutRuleRequest>> fn)
final Integer	priority()	API name: priority
final String	ruleId()	Required - The unique identifier of the query rule within the specified ruleset to be created or updated
final String	rulesetId()	Required - The unique identifier of the query ruleset containing the rule 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	setupPutRuleRequestDeserializer(ObjectDeserializer<PutRuleRequest.Builder> op)
final QueryRuleType	type()	Required - API name: type

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<PutRuleRequest> _DESERIALIZER

Json deserializer for PutRuleRequest

_ENDPOINT

public static final Endpoint<PutRuleRequest,PutRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "query_rules.put_rule".

Method Details

of

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

actions

public final QueryRuleActions actions()

Required - API name: actions

criteria

public final List<QueryRuleCriteria> criteria()

Required - API name: criteria

priority

@Nullable
public final Integer priority()

API name: priority

ruleId

public final String ruleId()

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

API name: rule_id

rulesetId

public final String rulesetId()

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

API name: ruleset_id

type

public final QueryRuleType type()

Required - API name: type

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)

setupPutRuleRequestDeserializer

protected static void setupPutRuleRequestDeserializer(ObjectDeserializer<PutRuleRequest.Builder> op)