Package co.elastic.clients.elasticsearch.synonyms

Class GetSynonymRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.GetSynonymRuleRequest

public class GetSynonymRuleRequest
extends RequestBase

Get a synonym rule.

Get a synonym rule from a synonym set.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetSynonymRuleRequest,GetSynonymRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.get_synonym_rule".

Method Summary

Modifier and Type	Method	Description
static GetSynonymRuleRequest	of(Function<GetSynonymRuleRequest.Builder,ObjectBuilder<GetSynonymRuleRequest>> fn)
GetSynonymRuleRequest.Builder	rebuild()
final String	ruleId()	Required - The ID of the synonym rule to retrieve.
final String	setId()	Required - The ID of the synonym set to retrieve the synonym rule from.

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<GetSynonymRuleRequest,GetSynonymRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.get_synonym_rule".

Method Details

of

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

ruleId

public final String ruleId()

Required - The ID of the synonym rule to retrieve.

API name: rule_id

setId

public final String setId()

Required - The ID of the synonym set to retrieve the synonym rule from.

API name: set_id

rebuild

public GetSynonymRuleRequest.Builder rebuild()

Returns:

New GetSynonymRuleRequest.Builder initialized with field values of this instance