Package co.elastic.clients.elasticsearch.synonyms

Class PutSynonymRuleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.synonyms.PutSynonymRuleRequest.Builder

All Implemented Interfaces:

WithJson<PutSynonymRuleRequest.Builder>, ObjectBuilder<PutSynonymRuleRequest>

Enclosing class:

PutSynonymRuleRequest

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

Builder for PutSynonymRuleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutSynonymRuleRequest	build()	Builds a PutSynonymRuleRequest.
final PutSynonymRuleRequest.Builder	refresh(Boolean value)	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 PutSynonymRuleRequest.Builder	ruleId(String value)	Required - The ID of the synonym rule to be updated or created.
protected PutSynonymRuleRequest.Builder	self()
final PutSynonymRuleRequest.Builder	setId(String value)	Required - The ID of the synonym set.
final PutSynonymRuleRequest.Builder	synonyms(String value)	Required - The synonym rule information definition, which must be in Solr format.

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

refresh

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

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 PutSynonymRuleRequest.Builder ruleId(String value)

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

API name: rule_id

setId

public final PutSynonymRuleRequest.Builder setId(String value)

Required - The ID of the synonym set.

API name: set_id

synonyms

public final PutSynonymRuleRequest.Builder synonyms(String value)

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

API name: synonyms

self

protected PutSynonymRuleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutSynonymRuleRequest.Builder>

build

public PutSynonymRuleRequest build()

Builds a PutSynonymRuleRequest.

Specified by:

build in interface ObjectBuilder<PutSynonymRuleRequest>

Throws:

NullPointerException - if some of the required fields are null.