Package com.algolia.search

Class ConfigBase.Builder<T extends ConfigBase.Builder<T>>

java.lang.Object

com.algolia.search.ConfigBase.Builder<T>

Direct Known Subclasses:

AnalyticsConfig.Builder, InsightsConfig.Builder, PersonalizationConfig.Builder, RecommendationConfig.Builder, SearchConfig.Builder

Enclosing class:

ConfigBase

public abstract static class ConfigBase.Builder<T extends ConfigBase.Builder<T>>
extends Object

Config base builder to ensure the immutability of the configuration.

Field Summary

Fields

Modifier and Type	Field	Description
protected CompressionType	compressionType

Constructor Summary

Constructors

Constructor	Description
Builder(String applicationID, String apiKey, List<StatefulHost> defaultHosts, CompressionType compressionType)	Builds a base configuration

Method Summary

Modifier and Type	Method	Description
T	addExtraHeaders(String headerKey, String headerValue)	Associates the specified value with the specified key in this map.
T	addExtraHeaders(Map<String,String> headers)	Copies all of the mappings from the specified map to this map.
abstract T	getThis()	To prevent unchecked cast warning.
T	setBatchSize(int batchSize)	Overrides the default batch size for save methods.
T	setConnectTimeOut(Integer connectTimeOut)	Overrides the default connect timeout.
T	setExecutorService(ExecutorService executorService)	Sets a custom executor service.
T	setHosts(List<StatefulHost> customHosts)	Sets a list of specific host to target.
T	setReadTimeOut(Integer readTimeOut)	Overrides the default read timeout.
T	setUseSystemProxy(boolean useSystemProxy)	Deprecated. Please use a custom HttpAsyncClientBuilder when instantiating the ApacheHttpRequester instead.
T	setWriteTimeOut(Integer writeTimeOut)	Overrides the default write timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

compressionType

protected CompressionType compressionType

Constructor Detail

Builder

public Builder(@Nonnull
               String applicationID,
               @Nonnull
               String apiKey,
               @Nonnull
               List<StatefulHost> defaultHosts,
               @Nonnull
               CompressionType compressionType)

Builds a base configuration

Parameters:

applicationID - The Algolia Application ID

apiKey - The API Key: could be Admin API Key or Search API Key

Throws:

NullPointerException - If the ApplicationID or the APIKey or the hosts are null

IllegalArgumentException - If the ApplicationID or the APIKey are empty

Method Detail

getThis

public abstract T getThis()

To prevent unchecked cast warning.

setUseSystemProxy

public T setUseSystemProxy(boolean useSystemProxy)

Deprecated.

Please use a custom HttpAsyncClientBuilder when instantiating the ApacheHttpRequester instead.

Makes the underlying Apache HTTP Client to use JVM/System settings for the proxy.

setBatchSize

public T setBatchSize(int batchSize)

Overrides the default batch size for save methods. Default = 1000 objects per chunk.

setReadTimeOut

public T setReadTimeOut(Integer readTimeOut)

Overrides the default read timeout. Default = 1000ms In milliseconds

setWriteTimeOut

public T setWriteTimeOut(Integer writeTimeOut)

Overrides the default write timeout. Default = 30000ms In milliseconds

setConnectTimeOut

public T setConnectTimeOut(Integer connectTimeOut)

Overrides the default connect timeout. Default = 2000ms In milliseconds

setHosts

public T setHosts(@Nonnull
                  List<StatefulHost> customHosts)

Sets a list of specific host to target. Default hosts will be overridden.

setExecutorService

public T setExecutorService(ExecutorService executorService)

Sets a custom executor service. Default ForkJoinPool will be overridden.

addExtraHeaders

public T addExtraHeaders(@Nonnull
                         String headerKey,
                         @Nonnull
                         String headerValue)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced.

addExtraHeaders

public T addExtraHeaders(Map<String,String> headers)

Copies all of the mappings from the specified map to this map. These mappings will replace any mappings that this map had for any of the keys currently in the specified map.