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. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

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 String	id()	Required - The id of the synonyms set to be created or updated
static PutSynonymRequest	of(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)
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 set information 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

_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)

id

public final String id()

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

API name: id

synonymsSet

public final List<SynonymRule> synonymsSet()

Required - The synonym set information to update

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)

setupPutSynonymRequestDeserializer

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