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, connectTimeout, customAgent, customAgentVersion, customHeaders, objectMapper, random, readTimeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
APIClient	build() Build the APIClient
protected abstract APIClient	build(APIClientConfiguration configuration)
GenericAPIClientBuilder	setConnectTimeout(int connectTimeout) Set the connect timeout of the HTTP client
GenericAPIClientBuilder	setExtraHeader(String key, String value) Set extra headers to the requests
GenericAPIClientBuilder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Set the Jackson ObjectMapper
GenericAPIClientBuilder	setReadTimeout(int readTimeout) Set the read timeout of the HTTP client
GenericAPIClientBuilder	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 GenericAPIClientBuilder 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 GenericAPIClientBuilder setExtraHeader(@Nonnull
                                              String key,
                                              String value)

Set extra headers to the requests

Overrides:

setExtraHeader in class GenericAPIClientBuilder

Parameters:

key - name of the header

value - value of the header

Returns:

this

setConnectTimeout

public GenericAPIClientBuilder 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 GenericAPIClientBuilder setReadTimeout(int readTimeout)

Set the read timeout of the HTTP client

Overrides:

setReadTimeout in class GenericAPIClientBuilder

Parameters:

readTimeout - the value in ms

Returns:

this

setObjectMapper

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

Set the Jackson ObjectMapper

Overrides:

setObjectMapper in class GenericAPIClientBuilder

Parameters:

objectMapper - the mapper

Returns:

this

build

protected abstract APIClient build(@Nonnull
                                   APIClientConfiguration configuration)

build

public APIClient build()

Build the APIClient

Returns:

the built APIClient