Package co.elastic.clients.elasticsearch.synonyms

Class DeleteSynonymRuleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.synonyms.DeleteSynonymRuleRequest.Builder

All Implemented Interfaces:

WithJson<DeleteSynonymRuleRequest.Builder>, ObjectBuilder<DeleteSynonymRuleRequest>

Enclosing class:

DeleteSynonymRuleRequest

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

Builder for DeleteSynonymRuleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteSynonymRuleRequest	build()	Builds a DeleteSynonymRuleRequest.
final DeleteSynonymRuleRequest.Builder	refresh(Boolean value)	If true, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
final DeleteSynonymRuleRequest.Builder	ruleId(String value)	Required - The ID of the synonym rule to delete.
protected DeleteSynonymRuleRequest.Builder	self()
final DeleteSynonymRuleRequest.Builder	setId(String value)	Required - The ID of the synonym set to update.

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 DeleteSynonymRuleRequest.Builder refresh(@Nullable
 Boolean value)

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

API name: refresh

ruleId

public final DeleteSynonymRuleRequest.Builder ruleId(String value)

Required - The ID of the synonym rule to delete.

API name: rule_id

setId

public final DeleteSynonymRuleRequest.Builder setId(String value)

Required - The ID of the synonym set to update.

API name: set_id

self

protected DeleteSynonymRuleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteSynonymRuleRequest.Builder>

build

public DeleteSynonymRuleRequest build()

Builds a DeleteSynonymRuleRequest.

Specified by:

build in interface ObjectBuilder<DeleteSynonymRuleRequest>

Throws:

NullPointerException - if some of the required fields are null.