Package co.elastic.clients.elasticsearch.synonyms

Class PutSynonymRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutSynonymRequest.Builder>

co.elastic.clients.elasticsearch.synonyms.PutSynonymRequest.Builder

All Implemented Interfaces:

WithJson<PutSynonymRequest.Builder>, ObjectBuilder<PutSynonymRequest>

Enclosing class:

PutSynonymRequest

public static class PutSynonymRequest.Builder
extends RequestBase.AbstractBuilder<PutSynonymRequest.Builder>
implements ObjectBuilder<PutSynonymRequest>

Builder for PutSynonymRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutSynonymRequest	build()	Builds a PutSynonymRequest.
final PutSynonymRequest.Builder	id(String value)	Required - The ID of the synonyms set to be created or updated.
final PutSynonymRequest.Builder	refresh(Boolean value)	If true, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
protected PutSynonymRequest.Builder	self()
final PutSynonymRequest.Builder	synonymsSet(SynonymRule value, SynonymRule... values)	Required - The synonym rules definitions for the synonyms set.
final PutSynonymRequest.Builder	synonymsSet(Function<SynonymRule.Builder,ObjectBuilder<SynonymRule>> fn)	Required - The synonym rules definitions for the synonyms set.
final PutSynonymRequest.Builder	synonymsSet(List<SynonymRule> list)	Required - The synonym rules definitions for the synonyms set.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

id

public final PutSynonymRequest.Builder id(String value)

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

API name: id

refresh

public final PutSynonymRequest.Builder refresh(@Nullable
 Boolean value)

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 PutSynonymRequest.Builder synonymsSet(List<SynonymRule> list)

Required - The synonym rules definitions for the synonyms set.

API name: synonyms_set

Adds all elements of list to synonymsSet.

synonymsSet

public final PutSynonymRequest.Builder synonymsSet(SynonymRule value,
 SynonymRule... values)

Required - The synonym rules definitions for the synonyms set.

API name: synonyms_set

Adds one or more values to synonymsSet.

synonymsSet

public final PutSynonymRequest.Builder synonymsSet(Function<SynonymRule.Builder,ObjectBuilder<SynonymRule>> fn)

Required - The synonym rules definitions for the synonyms set.

API name: synonyms_set

Adds a value to synonymsSet using a builder lambda.

self

protected PutSynonymRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutSynonymRequest.Builder>

build

public PutSynonymRequest build()

Builds a PutSynonymRequest.

Specified by:

build in interface ObjectBuilder<PutSynonymRequest>

Throws:

NullPointerException - if some of the required fields are null.