getSettings method

Future<IndexSettings> getSettings({
  1. required String indexName,
  2. RequestOptions? requestOptions,
})

Retrieves an object with non-null index settings.

Required API Key ACLs:

  • search

Parameters:

  • indexName Name of the index on which to perform the operation.
  • requestOptions additional request configuration.

Implementation

Future<IndexSettings> getSettings({
  required String indexName,
  RequestOptions? requestOptions,
}) async {
  assert(
    indexName.isNotEmpty,
    'Parameter `indexName` is required when calling `getSettings`.',
  );
  final request = ApiRequest(
    method: RequestMethod.get,
    path: r'/1/indexes/{indexName}/settings'.replaceAll(
        '{' r'indexName' '}', Uri.encodeComponent(indexName.toString())),
  );
  final response = await _retryStrategy.execute(
    request: request,
    options: requestOptions,
  );
  return deserialize<IndexSettings, IndexSettings>(
    response,
    'IndexSettings',
    growable: true,
  );
}