getSynonym method
Future<SynonymHit>
getSynonym({
- required String indexName,
- required String objectID,
- RequestOptions? requestOptions,
Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the search
operation.
Required API Key ACLs:
- settings
Parameters:
indexName
Name of the index on which to perform the operation.objectID
Unique identifier of a synonym object.requestOptions
additional request configuration.
Implementation
Future<SynonymHit> getSynonym({
required String indexName,
required String objectID,
RequestOptions? requestOptions,
}) async {
assert(
indexName.isNotEmpty,
'Parameter `indexName` is required when calling `getSynonym`.',
);
assert(
objectID.isNotEmpty,
'Parameter `objectID` is required when calling `getSynonym`.',
);
final request = ApiRequest(
method: RequestMethod.get,
path: r'/1/indexes/{indexName}/synonyms/{objectID}'
.replaceAll(
'{' r'indexName' '}', Uri.encodeComponent(indexName.toString()))
.replaceAll(
'{' r'objectID' '}', Uri.encodeComponent(objectID.toString())),
);
final response = await _retryStrategy.execute(
request: request,
options: requestOptions,
);
return deserialize<SynonymHit, SynonymHit>(
response,
'SynonymHit',
growable: true,
);
}