algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/QuerySuggestionsClient

QuerySuggestionsClient

algoliasearch.api.QuerySuggestionsClient
See theQuerySuggestionsClient companion object
class QuerySuggestionsClient(appId: String, apiKey: String, region: String, clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def createConfig(configurationWithIndex: ConfigurationWithIndex, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[BaseResponse]

Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Required API Key ACLs:

  • editSettings

Attributes

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteConfig(indexName: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[BaseResponse]

Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the Delete an index operation.

Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the Delete an index operation.

Required API Key ACLs:

  • editSettings

Value parameters

indexName

Query Suggestions index name.

Attributes

def getAllConfigs(requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Seq[ConfigurationResponse]]

Retrieves all Query Suggestions configurations of your Algolia application.

Retrieves all Query Suggestions configurations of your Algolia application.

Required API Key ACLs:

  • settings

Attributes

def getConfig(indexName: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ConfigurationResponse]

Retrieves a single Query Suggestions configuration by its index name.

Retrieves a single Query Suggestions configuration by its index name.

Required API Key ACLs:

  • settings

Value parameters

indexName

Query Suggestions index name.

Attributes

def getConfigStatus(indexName: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ConfigStatus]

Reports the status of a Query Suggestions index.

Reports the status of a Query Suggestions index.

Required API Key ACLs:

  • settings

Value parameters

indexName

Query Suggestions index name.

Attributes

def getLogFile(indexName: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[LogFile]

Retrieves the logs for a single Query Suggestions index.

Retrieves the logs for a single Query Suggestions index.

Required API Key ACLs:

  • settings

Value parameters

indexName

Query Suggestions index name.

Attributes

def updateConfig(indexName: String, configuration: Configuration, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[BaseResponse]

Updates a QuerySuggestions configuration.

Updates a QuerySuggestions configuration.

Required API Key ACLs:

  • editSettings

Value parameters

indexName

Query Suggestions index name.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
def setClientApiKey(apiKey: String): Unit

Attributes

Inherited from:
ApiClient
Generated with