Package co.elastic.clients.elasticsearch.query_rules

Class PutRuleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutRuleRequest.Builder>

co.elastic.clients.elasticsearch.query_rules.PutRuleRequest.Builder

All Implemented Interfaces:

WithJson<PutRuleRequest.Builder>, ObjectBuilder<PutRuleRequest>

Enclosing class:

PutRuleRequest

public static class PutRuleRequest.Builder
extends RequestBase.AbstractBuilder<PutRuleRequest.Builder>
implements ObjectBuilder<PutRuleRequest>

Builder for PutRuleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutRuleRequest.Builder	actions(QueryRuleActions value)	Required - The actions to take when the rule is matched.
final PutRuleRequest.Builder	actions(Function<QueryRuleActions.Builder,ObjectBuilder<QueryRuleActions>> fn)	Required - The actions to take when the rule is matched.
PutRuleRequest	build()	Builds a PutRuleRequest.
final PutRuleRequest.Builder	criteria(QueryRuleCriteria value, QueryRuleCriteria... values)	Required - The criteria that must be met for the rule to be applied.
final PutRuleRequest.Builder	criteria(Function<QueryRuleCriteria.Builder,ObjectBuilder<QueryRuleCriteria>> fn)	Required - The criteria that must be met for the rule to be applied.
final PutRuleRequest.Builder	criteria(List<QueryRuleCriteria> list)	Required - The criteria that must be met for the rule to be applied.
final PutRuleRequest.Builder	priority(Integer value)	API name: priority
final PutRuleRequest.Builder	ruleId(String value)	Required - The unique identifier of the query rule within the specified ruleset to be created or updated.
final PutRuleRequest.Builder	rulesetId(String value)	Required - The unique identifier of the query ruleset containing the rule to be created or updated.
protected PutRuleRequest.Builder	self()
final PutRuleRequest.Builder	type(QueryRuleType value)	Required - The type of rule.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

actions

public final PutRuleRequest.Builder actions(QueryRuleActions value)

Required - The actions to take when the rule is matched. The format of this action depends on the rule type.

API name: actions

actions

public final PutRuleRequest.Builder actions(Function<QueryRuleActions.Builder,ObjectBuilder<QueryRuleActions>> fn)

Required - The actions to take when the rule is matched. The format of this action depends on the rule type.

API name: actions

criteria

public final PutRuleRequest.Builder criteria(List<QueryRuleCriteria> list)

Required - The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.

API name: criteria

Adds all elements of list to criteria.

criteria

public final PutRuleRequest.Builder criteria(QueryRuleCriteria value,
 QueryRuleCriteria... values)

Required - The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.

API name: criteria

Adds one or more values to criteria.

criteria

public final PutRuleRequest.Builder criteria(Function<QueryRuleCriteria.Builder,ObjectBuilder<QueryRuleCriteria>> fn)

Required - The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.

API name: criteria

Adds a value to criteria using a builder lambda.

priority

public final PutRuleRequest.Builder priority(@Nullable
 Integer value)

API name: priority

ruleId

public final PutRuleRequest.Builder ruleId(String value)

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

API name: rule_id

rulesetId

public final PutRuleRequest.Builder rulesetId(String value)

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

API name: ruleset_id

type

public final PutRuleRequest.Builder type(QueryRuleType value)

Required - The type of rule.

API name: type

self

protected PutRuleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutRuleRequest.Builder>

build

public PutRuleRequest build()

Builds a PutRuleRequest.

Specified by:

build in interface ObjectBuilder<PutRuleRequest>

Throws:

NullPointerException - if some of the required fields are null.