Package co.elastic.clients.elasticsearch.synonyms

Class GetSynonymsSetsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.GetSynonymsSetsRequest

public class GetSynonymsSetsRequest
extends RequestBase

Get all synonym sets.

Get a summary of all defined synonym sets.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSynonymsSetsRequest.Builder	Builder for GetSynonymsSetsRequest.

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 Endpoint<GetSynonymsSetsRequest,GetSynonymsSetsResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.get_synonyms_sets".

Method Summary

Modifier and Type	Method	Description
final Integer	from()	The starting offset for synonyms sets to retrieve.
static GetSynonymsSetsRequest	of(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)
GetSynonymsSetsRequest.Builder	rebuild()
final Integer	size()	The maximum number of synonyms sets to retrieve.

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

_ENDPOINT

public static final Endpoint<GetSynonymsSetsRequest,GetSynonymsSetsResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.get_synonyms_sets".

Method Details

of

public static GetSynonymsSetsRequest of(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)

from

@Nullable
public final Integer from()

The starting offset for synonyms sets to retrieve.

API name: from

size

@Nullable
public final Integer size()

The maximum number of synonyms sets to retrieve.

API name: size

rebuild

public GetSynonymsSetsRequest.Builder rebuild()

Returns:

New GetSynonymsSetsRequest.Builder initialized with field values of this instance