Package co.elastic.clients.elasticsearch.query_rules

Class DeleteRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.query_rules.DeleteRuleRequest

public class DeleteRuleRequest
extends RequestBase

Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<DeleteRuleRequest,DeleteRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "query_rules.delete_rule".

Method Summary

Modifier and Type	Method	Description
static DeleteRuleRequest	of(Function<DeleteRuleRequest.Builder,ObjectBuilder<DeleteRuleRequest>> fn)
final String	ruleId()	Required - The unique identifier of the query rule within the specified ruleset to delete
final String	rulesetId()	Required - The unique identifier of the query ruleset containing the rule to delete

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

_ENDPOINT

public static final Endpoint<DeleteRuleRequest,DeleteRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "query_rules.delete_rule".

Method Details

of

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

ruleId

public final String ruleId()

Required - The unique identifier of the query rule within the specified ruleset to delete

API name: rule_id

rulesetId

public final String rulesetId()

Required - The unique identifier of the query ruleset containing the rule to delete

API name: ruleset_id