algoliasearch.config
Members list
Type members
Classlikes
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AgentSegment.type
Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class ClientOptions
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 Serializabletrait Producttrait Equalstrait ClientConfigclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ClientOptions.type
Companion object of CompressionType.
Companion object of CompressionType.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
CompressionType.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpRequest.type
Logger interface.
Logger configuration.
Logger configuration.
Value parameters
- level
-
Log level.
- logger
-
Logger.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RequestOptions.type
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 AutoCloseableclass Objecttrait Matchableclass Any