Module org.elasticsearch.server
Package org.elasticsearch.synonyms
Class SynonymsManagementAPIService
java.lang.Object
org.elasticsearch.synonyms.SynonymsManagementAPIService
Manages synonyms performing operations on the system index
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordstatic enum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SystemIndexDescriptorstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteSynonymRule(String synonymsSetId, String synonymRuleId, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener) voiddeleteSynonymsSet(String synonymSetId, ActionListener<AcknowledgedResponse> listener) voidgetSynonymRule(String synonymSetId, String synonymRuleId, ActionListener<SynonymRule> listener) voidgetSynonymSetRules(String synonymSetId, int from, int size, ActionListener<PagedResult<SynonymRule>> listener) Retrieves synonym rules for a synonym set, with pagination support.voidgetSynonymSetRules(String synonymSetId, ActionListener<PagedResult<SynonymRule>> listener) Retrieves all synonym rules for a synonym set.voidgetSynonymsSets(int from, int size, ActionListener<PagedResult<SynonymSetSummary>> listener) Returns all synonym sets with their rule counts, including empty synonym sets.voidputSynonymRule(String synonymsSetId, SynonymRule synonymRule, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener) voidputSynonymsSet(String synonymSetId, SynonymRule[] synonymsSet, ActionListener<SynonymsManagementAPIService.SynonymsReloadResult> listener)
-
Field Details
-
SYNONYMS_FEATURE_NAME
- See Also:
-
SYNONYMS_SET_FIELD
- See Also:
-
SYNONYMS_FIELD
-
SYNONYMS_ORIGIN
- See Also:
-
SYNONYMS_DESCRIPTOR
-
-
Constructor Details
-
SynonymsManagementAPIService
-
-
Method Details
-
getSynonymsSets
public void getSynonymsSets(int from, int size, ActionListener<PagedResult<SynonymSetSummary>> listener) Returns all synonym sets with their rule counts, including empty synonym sets.- Parameters:
from- The index of the first synonym set to returnsize- The number of synonym sets to returnlistener- The listener to return the synonym sets to
-
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
-