Package com.faunadb.client

Class FaunaClient.Builder

java.lang.Object

com.faunadb.client.FaunaClient.Builder

Enclosing class:

FaunaClient

public static final class FaunaClient.Builder
extends Object

A builder for creating an instance of FaunaClient

Method Summary

Modifier and Type	Method	Description
FaunaClient	build()	Returns a newly constructed FaunaClient with configuration based on the settings of this FaunaClient.Builder.
FaunaClient.Builder	withEndpoint(String endpoint)	Sets the FaunaDB endpoint url for the FaunaClient instance.
FaunaClient.Builder	withMetrics(MetricRegistry registry)	Sets a MetricRegistry that the FaunaClient will use to register and track Connection-level statistics.
FaunaClient.Builder	withQueryTimeout(Duration timeout)	Sets a global timeout for all the Queries issued by this client.
FaunaClient.Builder	withSecret(String secret)	Sets the secret to be passed to FaunaDB as a authentication token
FaunaClient.Builder	withUserAgent(String userAgent)	Sets the User-Agent header for all the Queries issued by this client.

Methods inherited from class java.lang.Object

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

Method Detail

withSecret

public FaunaClient.Builder withSecret(String secret)

Sets the secret to be passed to FaunaDB as a authentication token

Parameters:

secret - the auth token secret

Returns:

this FaunaClient.Builder object

withEndpoint

public FaunaClient.Builder withEndpoint(String endpoint)
                                 throws MalformedURLException

Sets the FaunaDB endpoint url for the FaunaClient instance.

Parameters:

endpoint - the root endpoint URL

Returns:

this FaunaClient.Builder object

Throws:

MalformedURLException - if the endpoint is invalid

withMetrics

public FaunaClient.Builder withMetrics(MetricRegistry registry)

Sets a MetricRegistry that the FaunaClient will use to register and track Connection-level statistics.

Parameters:

registry - the MetricRegistry instance.

Returns:

this FaunaClient.Builder object

withQueryTimeout

public FaunaClient.Builder withQueryTimeout(Duration timeout)

Sets a global timeout for all the Queries issued by this client.

Parameters:

timeout - the query timeout value. The timeout value has milliseconds precision.

Returns:

this FaunaClient.Builder object

withUserAgent

public FaunaClient.Builder withUserAgent(String userAgent)

Sets the User-Agent header for all the Queries issued by this client.

Parameters:

userAgent - the userAgent value

Returns:

this FaunaClient.Builder object

build

public FaunaClient build()

Returns a newly constructed FaunaClient with configuration based on the settings of this FaunaClient.Builder.

Returns:

FaunaClient