clearSynonyms method

Future<UpdatedAtResponse> clearSynonyms({ required String indexName, bool? forwardToReplicas, RequestOptions? requestOptions, })

Deletes all synonyms from the index.

Required API Key ACLs:

• editSettings

Parameters:

• indexName Name of the index on which to perform the operation.
• forwardToReplicas Whether changes are applied to replica indices.
• requestOptions additional request configuration.

Implementation

Future<UpdatedAtResponse> clearSynonyms({
  required String indexName,
  bool? forwardToReplicas,
  RequestOptions? requestOptions,
}) async {
  assert(
    indexName.isNotEmpty,
    'Parameter `indexName` is required when calling `clearSynonyms`.',
  );
  final request = ApiRequest(
    method: RequestMethod.post,
    path: r'/1/indexes/{indexName}/synonyms/clear'.replaceAll(
        '{' r'indexName' '}', Uri.encodeComponent(indexName.toString())),
    queryParams: {
      if (forwardToReplicas != null) 'forwardToReplicas': forwardToReplicas,
    },
  );
  final response = await _retryStrategy.execute(
    request: request,
    options: requestOptions,
  );
  return deserialize<UpdatedAtResponse, UpdatedAtResponse>(
    response,
    'UpdatedAtResponse',
    growable: true,
  );
}