algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.config

algoliasearch.config

package algoliasearch.config

Members list

Type members

Classlikes

case class AgentSegment(value: String, version: Option[String])

Represents a segment of algolia agent header.

Represents a segment of algolia agent header.

Value parameters

value

segment string value

version

optional version

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AgentSegment

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait CallType

Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.

Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Read.type
object Write.type
object CallType

Companion object of CallType.

Companion object of CallType.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
CallType.type
trait ClientConfig

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ClientOptions(agentSegments: Seq[AgentSegment], hosts: Seq[Host], connectTimeout: Duration, writeTimeout: Duration, readTimeout: Duration, defaultHeaders: Map[String, String], compressionType: CompressionType, logging: Option[Logging], customFormats: Option[Formats], requesterConfig: Option[Builder => ], customRequester: Option[Requester]) extends ClientConfig

Represents the configuration of an API client.

Represents the configuration of an API client.

Value parameters

agentSegments

segments to add to the Algolia agent header

compressionType

compression type to use for requests

connectTimeout

connection timeout

customFormats

custom JSON formats

customRequester

custom HTTP requester

defaultHeaders

default headers to add to requests

hosts

hosts to use for requests

logging

logging configuration

readTimeout

read timeout

requesterConfig

configuration for the HTTP requester

writeTimeout

write timeout

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ClientConfig
class Object
trait Matchable
class Any
Show all
object ClientOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait CompressionType

Compression type used for HTTP requests.

Compression type used for HTTP requests.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Gzip.type
object None.type
object CompressionType

Companion object of CompressionType.

Companion object of CompressionType.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Host(url: String, callTypes: Set[CallType], scheme: String, port: Option[Int])

Represents an Algolia host.

Represents an Algolia host.

Value parameters

callTypes

Whether this host should be used for read and/or write requests.

port

Host port

scheme

Host protocol (i.e. http, https)

url

Host url

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HttpRequest(method: String, path: String, read: Boolean, headers: Map[String, String], queryParameters: Map[String, String], body: Option[Any])

Represents an HTTP request.

Represents an HTTP request.

Value parameters

body

HTTP body

headers

HTTP headers

method

HTTP method

path

HTTP path

queryParameters

HTTP query parameters

read

Whether this request is a read request

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpRequest

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait LogLevel

Log level used for HTTP requests.

Log level used for HTTP requests.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Basic.type
object Body.type
object Headers.type
object None.type
object LogLevel

Companion object of LogLevel.

Companion object of LogLevel.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
LogLevel.type
trait Logger

Logger interface.

Logger interface.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Logger

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Logger.type
case class Logging(level: LogLevel, logger: Logger)

Logger configuration.

Logger configuration.

Value parameters

level

Log level.

logger

Logger.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Logging

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Logging.type
case class RequestOptions(headers: Map[String, String], queryParameters: Map[String, String], readTimeout: Option[Duration], writeTimeout: Option[Duration])

RequestOptions are used to pass extra parameters, headers, and timeouts to the request. Parameters set in the request option will override the default parameter.

RequestOptions are used to pass extra parameters, headers, and timeouts to the request. Parameters set in the request option will override the default parameter.

Value parameters

headers

HTTP headers

queryParameters

HTTP query parameters

readTimeout

HTTP read timeout

writeTimeout

HTTP write timeout

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Requester extends AutoCloseable

Represents a mechanism for executing HTTP requests and deserializing responses using JSON4S. It provides methods for making requests and returning the desired object representation. Implementations of this trait should ensure proper resource management.

Represents a mechanism for executing HTTP requests and deserializing responses using JSON4S. It provides methods for making requests and returning the desired object representation. Implementations of this trait should ensure proper resource management.

Attributes

Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
Generated with