Module org.elasticsearch.server

Package org.elasticsearch.synonyms

Class SynonymsManagementAPIService

java.lang.Object

org.elasticsearch.synonyms.SynonymsManagementAPIService

public class SynonymsManagementAPIService
extends Object

Manages synonyms performing operations on the system index

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SynonymsManagementAPIService.SynonymsReloadResult
static enum	SynonymsManagementAPIService.UpdateSynonymsResultStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemIndexDescriptor	SYNONYMS_DESCRIPTOR
static final String	SYNONYMS_FEATURE_NAME
static final String	SYNONYMS_FIELD
static final String	SYNONYMS_ORIGIN
static final String	SYNONYMS_SET_FIELD

Constructor Summary

Constructors

Constructor	Description
SynonymsManagementAPIService(Client client)

Method Summary

Modifier and Type	Method	Description
void	deleteSynonymRule(String synonymsSetId, String synonymRuleId, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)
void	deleteSynonymsSet(String synonymSetId, ActionListener<AcknowledgedResponse> listener)
void	getSynonymRule(String synonymSetId, String synonymRuleId, ActionListener<SynonymRule> listener)
void	getSynonymSetRules(String synonymSetId, int from, int size, ActionListener<PagedResult<SynonymRule>> listener)	Retrieves synonym rules for a synonym set, with pagination support.
void	getSynonymSetRules(String synonymSetId, ActionListener<PagedResult<SynonymRule>> listener)	Retrieves all synonym rules for a synonym set.
void	getSynonymsSets(int from, int size, ActionListener<PagedResult<SynonymSetSummary>> listener)
void	putSynonymRule(String synonymsSetId, SynonymRule synonymRule, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)
void	putSynonymsSet(String synonymSetId, SynonymRule[] synonymsSet, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SYNONYMS_FEATURE_NAME

public static final String SYNONYMS_FEATURE_NAME

See Also:

• Constant Field Values

SYNONYMS_SET_FIELD

public static final String SYNONYMS_SET_FIELD

See Also:

• Constant Field Values

SYNONYMS_FIELD

public static final String SYNONYMS_FIELD

SYNONYMS_ORIGIN

public static final String SYNONYMS_ORIGIN

See Also:

• Constant Field Values

SYNONYMS_DESCRIPTOR

public static final SystemIndexDescriptor SYNONYMS_DESCRIPTOR

Constructor Details

SynonymsManagementAPIService

public SynonymsManagementAPIService(Client client)

Method Details

getSynonymsSets

public void getSynonymsSets(int from,
 int size,
 ActionListener<PagedResult<SynonymSetSummary>> listener)

getSynonymSetRules

public void getSynonymSetRules(String synonymSetId,
 ActionListener<PagedResult<SynonymRule>> listener)

Retrieves all synonym rules for a synonym set.

Parameters:

synonymSetId -

listener -

getSynonymSetRules

public void getSynonymSetRules(String synonymSetId,
 int from,
 int size,
 ActionListener<PagedResult<SynonymRule>> listener)

Retrieves synonym rules for a synonym set, with pagination support. This method does not check that pagination is correct in terms of the max_result_window setting.

Parameters:

synonymSetId -

from -

size -

listener -

putSynonymsSet

public void putSynonymsSet(String synonymSetId,
 SynonymRule[] synonymsSet,
 ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)

putSynonymRule

public void putSynonymRule(String synonymsSetId,
 SynonymRule synonymRule,
 ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)

getSynonymRule

public void getSynonymRule(String synonymSetId,
 String synonymRuleId,
 ActionListener<SynonymRule> listener)

deleteSynonymRule

public void deleteSynonymRule(String synonymsSetId,
 String synonymRuleId,
 ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)

deleteSynonymsSet

public void deleteSynonymsSet(String synonymSetId,
 ActionListener<AcknowledgedResponse> listener)