Package co.elastic.clients.elasticsearch.synonyms

Class GetSynonymRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.synonyms.GetSynonymRequest.Builder

All Implemented Interfaces:

WithJson<GetSynonymRequest.Builder>, ObjectBuilder<GetSynonymRequest>

Enclosing class:

GetSynonymRequest

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

Builder for GetSynonymRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSynonymRequest	build()	Builds a GetSynonymRequest.
final GetSynonymRequest.Builder	from(Integer value)	Starting offset for query rules to be retrieved
final GetSynonymRequest.Builder	id(String value)	Required - "The id of the synonyms set to be retrieved
protected GetSynonymRequest.Builder	self()
final GetSynonymRequest.Builder	size(Integer value)	specifies a max number of query rules to retrieve

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

from

public final GetSynonymRequest.Builder from(@Nullable
 Integer value)

Starting offset for query rules to be retrieved

API name: from

id

public final GetSynonymRequest.Builder id(String value)

Required - "The id of the synonyms set to be retrieved

API name: id

size

public final GetSynonymRequest.Builder size(@Nullable
 Integer value)

specifies a max number of query rules to retrieve

API name: size

self

protected GetSynonymRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetSynonymRequest.Builder>

build

public GetSynonymRequest build()

Builds a GetSynonymRequest.

Specified by:

build in interface ObjectBuilder<GetSynonymRequest>

Throws:

NullPointerException - if some of the required fields are null.