deleteSynonym method
Future<DeletedAtResponse>
deleteSynonym({
- required String indexName,
- required String objectID,
- bool? forwardToReplicas,
- RequestOptions? requestOptions,
Deletes a synonym by its ID. To find the object IDs of your synonyms, use the search
operation.
Required API Key ACLs:
- editSettings
Parameters:
indexName
Name of the index on which to perform the operation.objectID
Unique identifier of a synonym object.forwardToReplicas
Whether changes are applied to replica indices.requestOptions
additional request configuration.
Implementation
Future<DeletedAtResponse> deleteSynonym({
required String indexName,
required String objectID,
bool? forwardToReplicas,
RequestOptions? requestOptions,
}) async {
assert(
indexName.isNotEmpty,
'Parameter `indexName` is required when calling `deleteSynonym`.',
);
assert(
objectID.isNotEmpty,
'Parameter `objectID` is required when calling `deleteSynonym`.',
);
final request = ApiRequest(
method: RequestMethod.delete,
path: r'/1/indexes/{indexName}/synonyms/{objectID}'
.replaceAll(
'{' r'indexName' '}', Uri.encodeComponent(indexName.toString()))
.replaceAll(
'{' r'objectID' '}', Uri.encodeComponent(objectID.toString())),
queryParams: {
if (forwardToReplicas != null) 'forwardToReplicas': forwardToReplicas,
},
);
final response = await _retryStrategy.execute(
request: request,
options: requestOptions,
);
return deserialize<DeletedAtResponse, DeletedAtResponse>(
response,
'DeletedAtResponse',
growable: true,
);
}