Package dev.openfga.sdk.api.configuration

Class Configuration

java.lang.Object

dev.openfga.sdk.api.configuration.Configuration

All Implemented Interfaces:

BaseConfiguration

Direct Known Subclasses:

ClientConfiguration

public class Configuration
extends java.lang.Object
implements BaseConfiguration

Configurations for an api client.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor	Description
Configuration()

Method Summary

Modifier and Type	Method	Description
Configuration	apiUrl(java.lang.String apiUrl)	Set the API URL for the http client.
void	assertValid()	Assert that the configuration is valid.
Configuration	connectTimeout(java.time.Duration connectTimeout)	Sets the connect timeout (in milliseconds) for the http client.
Configuration	credentials(Credentials credentials)	Set the credentials.
Configuration	defaultHeaders(java.util.Map<java.lang.String,java.lang.String> defaultHeaders)
java.lang.String	getApiUrl()	Get the API URL that was set.
java.time.Duration	getConnectTimeout()	Get connection timeout (in milliseconds).
Credentials	getCredentials()	Get the credentials.
java.util.Map<java.lang.String,java.lang.String>	getDefaultHeaders()
java.lang.Integer	getMaxRetries()
java.time.Duration	getMinimumRetryDelay()
java.time.Duration	getReadTimeout()	Get the read timeout that was set.
java.lang.String	getUserAgent()	Get the user agent.
Configuration	maxRetries(int maxRetries)
Configuration	minimumRetryDelay(java.time.Duration minimumRetryDelay)
Configuration	override(ConfigurationOverride configurationOverride)	Construct a new Configuration with any non-null values of a ConfigurationOverride and remaining values from this Configuration.
Configuration	readTimeout(java.time.Duration readTimeout)	Set the read timeout for the http client.
Configuration	userAgent(java.lang.String userAgent)	Set the user agent.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

Method Detail

assertValid

public void assertValid()
                 throws FgaInvalidParameterException

Assert that the configuration is valid.

Throws:

FgaInvalidParameterException

override

public Configuration override(ConfigurationOverride configurationOverride)

Construct a new Configuration with any non-null values of a ConfigurationOverride and remaining values from this Configuration.

Parameters:

configurationOverride - The values to override

Returns:

A new Configuration with values of this Configuration mixed with non-null values of configurationOverride

apiUrl

public Configuration apiUrl(java.lang.String apiUrl)

Set the API URL for the http client.

Parameters:

apiUrl - The URL.

Returns:

This object.

getApiUrl

public java.lang.String getApiUrl()

Get the API URL that was set.

Specified by:

getApiUrl in interface BaseConfiguration

Returns:

The url.

userAgent

public Configuration userAgent(java.lang.String userAgent)

Set the user agent.

Within the context of a single request, a "User-Agent" header from either defaultHeaders(Map) or ConfigurationOverride.additionalHeaders(Map) will take precedence over this value.

Parameters:

userAgent - The user agent.

Returns:

This object.

getUserAgent

public java.lang.String getUserAgent()

Get the user agent.

Specified by:

getUserAgent in interface BaseConfiguration

Returns:

The user agent.

credentials

public Configuration credentials(Credentials credentials)

Set the credentials.

Parameters:

credentials - The credentials.

Returns:

This object.

getCredentials

public Credentials getCredentials()

Get the credentials.

Returns:

The credentials.

readTimeout

public Configuration readTimeout(java.time.Duration readTimeout)

Set the read timeout for the http client.

This is the value used by default for each request, though it can be overridden on a per-request basis with a request interceptor.

Parameters:

readTimeout - The read timeout used by default by the http client. Setting this value to null resets the timeout to an effectively infinite value.

Returns:

This object.

getReadTimeout

public java.time.Duration getReadTimeout()

Get the read timeout that was set.

Specified by:

getReadTimeout in interface BaseConfiguration

Returns:

The read timeout, or null if no timeout was set. Null represents an infinite wait time.

connectTimeout

public Configuration connectTimeout(java.time.Duration connectTimeout)

Sets the connect timeout (in milliseconds) for the http client.

In the case where a new connection needs to be established, if the connection cannot be established within the given duration, then HttpClient::send throws an HttpConnectTimeoutException, or HttpClient::sendAsync completes exceptionally with an HttpConnectTimeoutException. If a new connection does not need to be established, for example if a connection can be reused from a previous request, then this timeout duration has no effect.

Parameters:

connectTimeout - connection timeout in milliseconds

Returns:

This object.

getConnectTimeout

public java.time.Duration getConnectTimeout()

Get connection timeout (in milliseconds).

Specified by:

getConnectTimeout in interface BaseConfiguration

Returns:

Timeout in milliseconds

maxRetries

public Configuration maxRetries(int maxRetries)

getMaxRetries

public java.lang.Integer getMaxRetries()

Specified by:

getMaxRetries in interface BaseConfiguration

minimumRetryDelay

public Configuration minimumRetryDelay(java.time.Duration minimumRetryDelay)

getMinimumRetryDelay

public java.time.Duration getMinimumRetryDelay()

Specified by:

getMinimumRetryDelay in interface BaseConfiguration

defaultHeaders

public Configuration defaultHeaders(java.util.Map<java.lang.String,java.lang.String> defaultHeaders)

getDefaultHeaders

public java.util.Map<java.lang.String,java.lang.String> getDefaultHeaders()