Package co.elastic.clients.elasticsearch.synonyms

Class PutSynonymRuleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.PutSynonymRuleRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutSynonymRuleRequest
extends RequestBase
implements JsonpSerializable

Create or update a synonym rule. Create or update a synonym rule in a synonym set.

If any of the synonym rules included is invalid, the API returns an error.

When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<PutSynonymRuleRequest>	_DESERIALIZER	Json deserializer for PutSynonymRuleRequest
static final Endpoint<PutSynonymRuleRequest,PutSynonymRuleResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.put_synonym_rule".

Method Summary

Modifier and Type	Method	Description
static PutSynonymRuleRequest	of(Function<PutSynonymRuleRequest.Builder,ObjectBuilder<PutSynonymRuleRequest>> fn)
final Boolean	refresh()	If true, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
final String	ruleId()	Required - The ID of the synonym rule to be updated or created.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final String	setId()	Required - The ID of the synonym set.
protected static void	setupPutSynonymRuleRequestDeserializer(ObjectDeserializer<PutSynonymRuleRequest.Builder> op)
final String	synonyms()	Required - The synonym rule information definition, which must be in Solr format.

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

_DESERIALIZER

public static final JsonpDeserializer<PutSynonymRuleRequest> _DESERIALIZER

Json deserializer for PutSynonymRuleRequest

_ENDPOINT

public static final Endpoint<PutSynonymRuleRequest,PutSynonymRuleResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.put_synonym_rule".

Method Details

of

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

refresh

@Nullable
public final Boolean refresh()

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

API name: refresh

ruleId

public final String ruleId()

Required - The ID of the synonym rule to be updated or created.

API name: rule_id

setId

public final String setId()

Required - The ID of the synonym set.

API name: set_id

synonyms

public final String synonyms()

Required - The synonym rule information definition, which must be in Solr format.

API name: synonyms

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutSynonymRuleRequestDeserializer

protected static void setupPutSynonymRuleRequestDeserializer(ObjectDeserializer<PutSynonymRuleRequest.Builder> op)