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(querySuggestionsConfigurationWithIndex: QuerySuggestionsConfigurationWithIndex, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[BaseResponse]

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

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

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$2: 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$3: 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$4: 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]

Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Value parameters

indexName

Query Suggestions index name.

Attributes

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

List all Query Suggestions configurations of your Algolia application.

List all Query Suggestions configurations of your Algolia application.

Attributes

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

Get a single Query Suggestions configuration.

Get a single Query Suggestions configuration.

Value parameters

indexName

Query Suggestions index name.

Attributes

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

Report the status of a Query Suggestions index.

Report the status of a Query Suggestions index.

Value parameters

indexName

Query Suggestions index name.

Attributes

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

Get the logs for a single Query Suggestions index.

Get the logs for a single Query Suggestions index.

Value parameters

indexName

Query Suggestions index name.

Attributes

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

Update a QuerySuggestions configuration.

Update a QuerySuggestions configuration.

Value parameters

indexName

Query Suggestions index name.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
Generated with