Package io.vanslog.spring.data.meilisearch.client

Class ClientConfigurationBuilder

java.lang.Object

io.vanslog.spring.data.meilisearch.client.ClientConfigurationBuilder

public class ClientConfigurationBuilder
extends Object

A builder for Meilisearch ClientConfiguration.

Author:

Junghoon Ban

Constructor Summary

Constructors

Constructor	Description
ClientConfigurationBuilder()	Create a new ClientConfigurationBuilder.

Method Summary

Modifier and Type	Method	Description
ClientConfiguration	build()	Build a ClientConfiguration with the given parameters.
ClientConfigurationBuilder	connectedTo(String hostUrl)	Connect to the given hostUrl.
ClientConfigurationBuilder	connectedToLocalhost()	Connect to localhost:7700.
ClientConfigurationBuilder	withApiKey(String apiKey)	Configure API key to access Meilisearch instance.
ClientConfigurationBuilder	withClientAgents(String[] clientAgents)	Configure client agents that will be sent with User-Agent header.
ClientConfigurationBuilder	withRequestInterval(int requestInterval)	Configure request interval to wait for task to complete.
ClientConfigurationBuilder	withRequestTimeout(int requestTimeout)	Configure request timeout to wait for task to complete.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientConfigurationBuilder

public ClientConfigurationBuilder()

Create a new ClientConfigurationBuilder.

Method Details

connectedToLocalhost

public ClientConfigurationBuilder connectedToLocalhost()

Connect to localhost:7700.

Returns:

ClientConfigurationBuilder

connectedTo

public ClientConfigurationBuilder connectedTo(String hostUrl)

Connect to the given hostUrl.

Parameters:

hostUrl - the hostUrl to connect to

Returns:

ClientConfigurationBuilder

withApiKey

public ClientConfigurationBuilder withApiKey(String apiKey)

Configure API key to access Meilisearch instance.

Parameters:

apiKey - the apiKey to use

Returns:

ClientConfigurationBuilder

withClientAgents

public ClientConfigurationBuilder withClientAgents(String[] clientAgents)

Configure client agents that will be sent with User-Agent header.

Parameters:

clientAgents - String array of client agents

Returns:

ClientConfigurationBuilder

withRequestTimeout

public ClientConfigurationBuilder withRequestTimeout(int requestTimeout)

Configure request timeout to wait for task to complete.

Parameters:

requestTimeout - in milliseconds

Returns:

ClientConfigurationBuilder

withRequestInterval

public ClientConfigurationBuilder withRequestInterval(int requestInterval)

Configure request interval to wait for task to complete.

Parameters:

requestInterval - in milliseconds

Returns:

ClientConfigurationBuilder

build

public ClientConfiguration build()

Build a ClientConfiguration with the given parameters.

Returns:

ClientConfiguration