Package co.elastic.clients.elasticsearch.query_rules

Class GetRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.query_rules.GetRuleRequest

public class GetRuleRequest
extends RequestBase

Get a query rule. Get details about a query rule within a query ruleset.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetRuleRequest,GetRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "query_rules.get_rule".

Method Summary

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

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<GetRuleRequest,GetRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "query_rules.get_rule".

Method Details

of

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

ruleId

public final String ruleId()

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

API name: rule_id

rulesetId

public final String rulesetId()

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

API name: ruleset_id