Package co.elastic.clients.elasticsearch.query_rules

Class QueryRuleActions

java.lang.Object

co.elastic.clients.elasticsearch.query_rules.QueryRuleActions

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class QueryRuleActions
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<QueryRuleActions>	_DESERIALIZER	Json deserializer for QueryRuleActions

Method Summary

Modifier and Type	Method	Description
final List<PinnedDoc>	docs()	The documents to apply the rule to.
final List<String>	ids()	The unique document IDs of the documents to apply the rule to.
static QueryRuleActions	of(Function<QueryRuleActions.Builder,ObjectBuilder<QueryRuleActions>> fn)
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	setupQueryRuleActionsDeserializer(ObjectDeserializer<QueryRuleActions.Builder> op)
String	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<QueryRuleActions> _DESERIALIZER

Json deserializer for QueryRuleActions

Method Details

of

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

ids

public final List<String> ids()

The unique document IDs of the documents to apply the rule to. Only one of ids or docs may be specified and at least one must be specified.

API name: ids

docs

public final List<PinnedDoc> docs()

The documents to apply the rule to. Only one of ids or docs may be specified and at least one must be specified. There is a maximum value of 100 documents in a rule. You can specify the following attributes for each document:

• _index: The index of the document to pin.
• _id: The unique document ID.

API name: docs

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)

toString

public String toString()

Overrides:

toString in class Object

setupQueryRuleActionsDeserializer

protected static void setupQueryRuleActionsDeserializer(ObjectDeserializer<QueryRuleActions.Builder> op)