Package co.elastic.clients.elasticsearch.synonyms

Class DeleteSynonymRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.DeleteSynonymRuleRequest

public class DeleteSynonymRuleRequest
extends RequestBase

Delete a synonym rule. Delete a synonym rule from a synonym set.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteSynonymRuleRequest,DeleteSynonymRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.delete_synonym_rule".

Method Summary

Modifier and Type	Method	Description
static DeleteSynonymRuleRequest	of(Function<DeleteSynonymRuleRequest.Builder,ObjectBuilder<DeleteSynonymRuleRequest>> fn)
final Boolean	refresh()	If true, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
final String	ruleId()	Required - The ID of the synonym rule to delete.
final String	setId()	Required - The ID of the synonym set to update.

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<DeleteSynonymRuleRequest,DeleteSynonymRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.delete_synonym_rule".

Method Details

of

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

refresh

@Nullable
public final Boolean refresh()

If true, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning. If false, analyzers will not be reloaded with the deleted synonym rule

API name: refresh

ruleId

public final String ruleId()

Required - The ID of the synonym rule to delete.

API name: rule_id

setId

public final String setId()

Required - The ID of the synonym set to update.

API name: set_id