Package co.elastic.clients.elasticsearch.synonyms

Class GetSynonymRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.synonyms.GetSynonymRequest

public class GetSynonymRequest
extends RequestBase

Get a synonym set.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetSynonymRequest,GetSynonymResponse,ErrorResponse>	_ENDPOINT	Endpoint "synonyms.get_synonym".

Method Summary

Modifier and Type	Method	Description
final Integer	from()	The starting offset for synonym rules to retrieve.
final String	id()	Required - The synonyms set identifier to retrieve.
static GetSynonymRequest	of(Function<GetSynonymRequest.Builder,ObjectBuilder<GetSynonymRequest>> fn)
GetSynonymRequest.Builder	rebuild()
final String	searchAfter()	The synonym rule ID to use as a cursor for pagination.
final Integer	size()	The max number of synonym rules 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<GetSynonymRequest,GetSynonymResponse,ErrorResponse> _ENDPOINT

Endpoint "synonyms.get_synonym".

Method Details

of

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

from

@Nullable
public final Integer from()

The starting offset for synonym rules to retrieve.

API name: from

id

public final String id()

Required - The synonyms set identifier to retrieve.

API name: id

searchAfter

@Nullable
public final String searchAfter()

The synonym rule ID to use as a cursor for pagination. The next page of results will start after this rule ID. This parameter cannot be used with from.

API name: search_after

size

@Nullable
public final Integer size()

The max number of synonym rules to retrieve.

API name: size

rebuild

public GetSynonymRequest.Builder rebuild()

Returns:

New GetSynonymRequest.Builder initialized with field values of this instance