Fauna.Configuration Class Reference

Configuration is a class used to configure a Fauna Client. It encapsulates various settings such as the Endpoint, secret, query timeout, and others. More...

Public Member Functions
	Configuration (string secret, HttpClient? httpClient=null)
	Initializes a new instance of the Configuration record with the specified secret key.

Properties
bool	DisposeHttpClient [get]
	Whether the Client should dispose of the HttpClient on Dispose.
HttpClient	HttpClient [get]
	The HTTP Client to use for requests.
string	Secret [get]
	The secret key used for authentication.
Uri	Endpoint = Constants.Endpoints.Default [get]
	The endpoint URL of the Fauna server.
QueryOptions?	DefaultQueryOptions = null [get]
	Default options for queries sent to Fauna.
RetryConfiguration	RetryConfiguration = new(3, TimeSpan.FromSeconds(20)) [get]
	The retry configuration to apply to requests.
IStatsCollector?	StatsCollector = new StatsCollector() [get]
	StatsCollector for the client.

Detailed Description

Configuration is a class used to configure a Fauna Client. It encapsulates various settings such as the Endpoint, secret, query timeout, and others.

Definition at line 7 of file Configuration.cs.

Constructor & Destructor Documentation

Configuration()

Fauna.Configuration.Configuration	(	string	secret,
		HttpClient?	httpClient = null )

Initializes a new instance of the Configuration record with the specified secret key.

Parameters

secret	The secret key used for authentication.
httpClient	The HttpClient to use.

Definition at line 50 of file Configuration.cs.

Property Documentation

DefaultQueryOptions

QueryOptions? Fauna.Configuration.DefaultQueryOptions = null

get

Default options for queries sent to Fauna.

Definition at line 32 of file Configuration.cs.

DisposeHttpClient

bool Fauna.Configuration.DisposeHttpClient

get

Whether the Client should dispose of the HttpClient on Dispose.

Definition at line 12 of file Configuration.cs.

Endpoint

Uri Fauna.Configuration.Endpoint = Constants.Endpoints.Default

get

The endpoint URL of the Fauna server.

Definition at line 27 of file Configuration.cs.

HttpClient

HttpClient Fauna.Configuration.HttpClient

get

The HTTP Client to use for requests.

Definition at line 17 of file Configuration.cs.

RetryConfiguration

RetryConfiguration Fauna.Configuration.RetryConfiguration = new(3, TimeSpan.FromSeconds(20))

get

The retry configuration to apply to requests.

Definition at line 37 of file Configuration.cs.

Secret

string Fauna.Configuration.Secret

get

The secret key used for authentication.

Definition at line 22 of file Configuration.cs.

StatsCollector

IStatsCollector? Fauna.Configuration.StatsCollector = new StatsCollector()

get

StatsCollector for the client.

Definition at line 43 of file Configuration.cs.

---

The documentation for this class was generated from the following file:

• Fauna/Client/Configuration.cs