Package co.elastic.clients.elasticsearch._types

Class RuleRetriever

java.lang.Object

co.elastic.clients.elasticsearch._types.RetrieverBase

co.elastic.clients.elasticsearch._types.RuleRetriever

All Implemented Interfaces:

RetrieverVariant, JsonpSerializable

@JsonpDeserializable
public class RuleRetriever
extends RetrieverBase
implements RetrieverVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase

RetrieverBase.AbstractBuilder<BuilderT extends RetrieverBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Retriever.Kind	_retrieverKind()	Retriever variant kind.
final JsonData	matchCriteria()	Required - The match criteria that will determine if a rule in the provided rulesets should be applied.
static RuleRetriever	of(Function<RuleRetriever.Builder,ObjectBuilder<RuleRetriever>> fn)
final Integer	rankWindowSize()	This value determines the size of the individual result set.
final Retriever	retriever()	Required - The retriever whose results rules should be applied to.
final List<String>	rulesetIds()	Required - The ruleset IDs containing the rules this retriever is evaluating against.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRuleRetrieverDeserializer(ObjectDeserializer<RuleRetriever.Builder> op)

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

filter, minScore, name, serialize, setupRetrieverBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.RetrieverVariant

_toRetriever

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RuleRetriever> _DESERIALIZER

Json deserializer for RuleRetriever

Method Details

of

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

_retrieverKind

public Retriever.Kind _retrieverKind()

Retriever variant kind.

Specified by:

_retrieverKind in interface RetrieverVariant

rulesetIds

public final List<String> rulesetIds()

Required - The ruleset IDs containing the rules this retriever is evaluating against.

API name: ruleset_ids

matchCriteria

public final JsonData matchCriteria()

Required - The match criteria that will determine if a rule in the provided rulesets should be applied.

API name: match_criteria

retriever

public final Retriever retriever()

Required - The retriever whose results rules should be applied to.

API name: retriever

rankWindowSize

@Nullable
public final Integer rankWindowSize()

This value determines the size of the individual result set.

API name: rank_window_size

serializeInternal

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

Overrides:

serializeInternal in class RetrieverBase

setupRuleRetrieverDeserializer

protected static void setupRuleRetrieverDeserializer(ObjectDeserializer<RuleRetriever.Builder> op)