Package co.elastic.clients.elasticsearch.synonyms

Class PutSynonymRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.PutSynonymRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutSynonymRequest
extends RequestBase
implements JsonpSerializable

Create or update a synonym set.

Synonym sets are limited to a maximum of 100,000 synonym rules per set by default. This limit is configurable using the synonyms.max_synonym_rules cluster setting.

When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.

For practical examples of how to create or update a synonyms set, refer to the External documentation.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutSynonymRequest>	_DESERIALIZER	Json deserializer for PutSynonymRequest
static final Endpoint<PutSynonymRequest,PutSynonymResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.put_synonym".

Method Summary

Modifier and Type	Method	Description
final Boolean	append()	If true, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.
final String	id()	Required - The ID of the synonyms set to be created or updated.
static PutSynonymRequest	of(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)
PutSynonymRequest.Builder	rebuild()
final Boolean	refresh()	If true, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutSynonymRequestDeserializer(ObjectDeserializer<PutSynonymRequest.Builder> op)
final List<SynonymRule>	synonymsSet()	Required - The synonym rules definitions for the synonyms set.

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<PutSynonymRequest> _DESERIALIZER

Json deserializer for PutSynonymRequest

_ENDPOINT

public static final Endpoint<PutSynonymRequest,PutSynonymResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.put_synonym".

Method Details

of

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

append

@Nullable
public final Boolean append()

If true, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules. If false, the entire synonyms set is replaced with the new synonym rules definitions.

API name: append

id

public final String id()

Required - The ID of the synonyms set to be created or updated.

API name: id

refresh

@Nullable
public final Boolean refresh()

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

API name: refresh

synonymsSet

public final List<SynonymRule> synonymsSet()

Required - The synonym rules definitions for the synonyms set.

API name: synonyms_set

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)

rebuild

public PutSynonymRequest.Builder rebuild()

Returns:

New PutSynonymRequest.Builder initialized with field values of this instance

setupPutSynonymRequestDeserializer

protected static void setupPutSynonymRequestDeserializer(ObjectDeserializer<PutSynonymRequest.Builder> op)