Update index settings

Update the specified index settings.

Index settings that you don’t specify are left unchanged. Specify null to reset a setting to its default value.

For best performance, update the index settings before you add new records to your index.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = client.setSettings(
  indexName = "ALGOLIA_INDEX_NAME",
  indexSettings = IndexSettings(
    paginationLimitedTo = Some(10)
  ),
  forwardToReplicas = Some(true)
)
Did you find this page helpful?
Scala API clients v2