Package com.algolia.search

Class APIClientBuilder

java.lang.Object

com.algolia.search.GenericAPIClientBuilder

com.algolia.search.APIClientBuilder

public abstract class APIClientBuilder
extends GenericAPIClientBuilder

Base class to create APIClient

Field Summary

Fields inherited from class com.algolia.search.GenericAPIClientBuilder

apiKey, applicationId, buildHosts, connectTimeout, customAgent, customAgentVersion, customHeaders, hostDownTimeout, maxConnTotal, objectMapper, queryHosts, random, readTimeout

Constructor Summary

Constructors

Constructor	Description
APIClientBuilder(String applicationId, String apiKey)	Initialize this builder with the applicationId and apiKey

Method Summary

Modifier and Type	Method	Description
GenericAPIClientBuilder	addExtraHeader(String key, String value)	Add extra headers to the requests
APIClient	build()	Build the APIClient
protected abstract APIClient	build(APIClientConfiguration configuration)
APIClientBuilder	setBuildHosts(List<String> buildHosts)	Set the hosts for indexing & building
APIClientBuilder	setConnectTimeout(int connectTimeout)	Set the connect timeout of the HTTP client
APIClientBuilder	setExtraHeader(String key, String value)	Deprecated: use GenericAPIClientBuilder.addExtraHeader(String, String)
APIClientBuilder	setHostDownTimeout(int hostDownTimeout)	Set the retry timeout to detect if a host is down
APIClientBuilder	setMaxConnTotal(int maxConnTotal)	Set the maximum of connection, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder
APIClientBuilder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Set the Jackson ObjectMapper
APIClientBuilder	setQueryHosts(List<String> queryHosts)	Set the hosts for search & queries
APIClientBuilder	setReadTimeout(int readTimeout)	Set the read timeout of the HTTP client
APIClientBuilder	setUserAgent(String customAgent, String customAgentVersion)	Customize the user agent

Methods inherited from class com.algolia.search.GenericAPIClientBuilder

generateBuildHosts, generateHeaders, generateQueryHosts

Methods inherited from class java.lang.Object

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

Constructor Detail

APIClientBuilder

public APIClientBuilder(@Nonnull
                        String applicationId,
                        @Nonnull
                        String apiKey)

Initialize this builder with the applicationId and apiKey

Parameters:

applicationId - APP_ID can be found on https://www.algolia.com/api-keys

apiKey - Algolia API_KEY can also be found on https://www.algolia.com/api-keys

Method Detail

setUserAgent

public APIClientBuilder setUserAgent(@Nonnull
                                     String customAgent,
                                     @Nonnull
                                     String customAgentVersion)

Customize the user agent

Overrides:

setUserAgent in class GenericAPIClientBuilder

Parameters:

customAgent - key to add to the user agent

customAgentVersion - value of this key to add to the user agent

Returns:

this

setExtraHeader

public APIClientBuilder setExtraHeader(@Nonnull
                                       String key,
                                       String value)

Description copied from class: GenericAPIClientBuilder

Deprecated: use GenericAPIClientBuilder.addExtraHeader(String, String)

Overrides:

setExtraHeader in class GenericAPIClientBuilder

addExtraHeader

public GenericAPIClientBuilder addExtraHeader(@Nonnull
                                              String key,
                                              String value)

Description copied from class: GenericAPIClientBuilder

Add extra headers to the requests

Overrides:

addExtraHeader in class GenericAPIClientBuilder

Parameters:

key - name of the header

value - value of the header

Returns:

this

setConnectTimeout

public APIClientBuilder setConnectTimeout(int connectTimeout)

Set the connect timeout of the HTTP client

Overrides:

setConnectTimeout in class GenericAPIClientBuilder

Parameters:

connectTimeout - the value in ms

Returns:

this

setReadTimeout

public APIClientBuilder setReadTimeout(int readTimeout)

Set the read timeout of the HTTP client

Overrides:

setReadTimeout in class GenericAPIClientBuilder

Parameters:

readTimeout - the value in ms

Returns:

this

setHostDownTimeout

public APIClientBuilder setHostDownTimeout(int hostDownTimeout)

Set the retry timeout to detect if a host is down

Overrides:

setHostDownTimeout in class GenericAPIClientBuilder

Parameters:

hostDownTimeout - the value in ms

Returns:

this

setObjectMapper

public APIClientBuilder setObjectMapper(@Nonnull
                                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Set the Jackson ObjectMapper

Overrides:

setObjectMapper in class GenericAPIClientBuilder

Parameters:

objectMapper - the mapper

Returns:

this

setQueryHosts

public APIClientBuilder setQueryHosts(List<String> queryHosts)

Description copied from class: GenericAPIClientBuilder

Set the hosts for search & queries

Overrides:

setQueryHosts in class GenericAPIClientBuilder

Parameters:

queryHosts - the list of hosts for search

Returns:

this

setBuildHosts

public APIClientBuilder setBuildHosts(List<String> buildHosts)

Description copied from class: GenericAPIClientBuilder

Set the hosts for indexing & building

Overrides:

setBuildHosts in class GenericAPIClientBuilder

Parameters:

buildHosts - the list of hosts for indexing/building

Returns:

this

setMaxConnTotal

public APIClientBuilder setMaxConnTotal(int maxConnTotal)

Description copied from class: GenericAPIClientBuilder

Set the maximum of connection, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder

Overrides:

setMaxConnTotal in class GenericAPIClientBuilder

Parameters:

maxConnTotal - the max number of connections

Returns:

this

build

protected abstract APIClient build(@Nonnull
                                   APIClientConfiguration configuration)

build

public APIClient build()

Build the APIClient

Returns:

the built APIClient