searchRules method
Future<SearchRulesResponse>
searchRules({
- required String indexName,
- SearchRulesParams? searchRulesParams,
- RequestOptions? requestOptions,
Searches for rules in your index.
Required API Key ACLs:
- settings
Parameters:
indexName
Name of the index on which to perform the operation.searchRulesParams
requestOptions
additional request configuration.
Implementation
Future<SearchRulesResponse> searchRules({
required String indexName,
SearchRulesParams? searchRulesParams,
RequestOptions? requestOptions,
}) async {
assert(
indexName.isNotEmpty,
'Parameter `indexName` is required when calling `searchRules`.',
);
final request = ApiRequest(
method: RequestMethod.post,
path: r'/1/indexes/{indexName}/rules/search'.replaceAll(
'{' r'indexName' '}', Uri.encodeComponent(indexName.toString())),
isRead: true,
body: searchRulesParams?.toJson(),
);
final response = await _retryStrategy.execute(
request: request,
options: requestOptions,
);
return deserialize<SearchRulesResponse, SearchRulesResponse>(
response,
'SearchRulesResponse',
growable: true,
);
}