Fauna.Exceptions.ServiceException Class Reference

Represents an exception related to Fauna service errors, particularly for query failures. More...

Inheritance diagram for Fauna.Exceptions.ServiceException:

Public Member Functions
	ServiceException (string message)
	Initializes a new instance of the ServiceException class with a specified query failure details and error message.
	ServiceException (string message, QueryFailure failure)
	Initializes a new instance of the ServiceException class with a specified query failure details and error message.
Public Member Functions inherited from Fauna.Exceptions.FaunaException
	FaunaException ()
	FaunaException (string message)
	FaunaException (string message, Exception innerException)

Properties
HttpStatusCode?	StatusCode [get, set]
	The HTTP status code.
string?	ErrorCode [get]
	The error code when a query fails.
string?	Summary [get]
	A comprehensive, human readable summary of any errors, warnings and/or logs returned from the query.
QueryStats	Stats [get]
	The query stats for the request.
long?	TxnTs [get]
	The transaction commit time in micros since epoch. Used by drivers to populate the x-last-txn-ts request header in order to get a consistent prefix RYOW guarantee.
long?	SchemaVersion [get]
	The schema version used by the query. This can be used by clients displaying schema to determine when they should refresh their schema. If the schema version that a client has stored differs from the one returned by the query, schema should be refreshed.
IDictionary< string, string >	QueryTags [get]
	The tags on the x-query-tags header, if it was provided.

Detailed Description

Represents an exception related to Fauna service errors, particularly for query failures.

Definition at line 15 of file ServiceException.cs.

Constructor & Destructor Documentation

ServiceException() [1/2]

Fauna.Exceptions.ServiceException.ServiceException

(

string

message

)

Initializes a new instance of the ServiceException class with a specified query failure details and error message.

Parameters

message

The error message that explains the reason for the exception.

Definition at line 61 of file ServiceException.cs.

ServiceException() [2/2]

Fauna.Exceptions.ServiceException.ServiceException	(	string	message,
		QueryFailure	failure )

Initializes a new instance of the ServiceException class with a specified query failure details and error message.

Parameters

message	The error message that explains the reason for the exception.
failure	A QueryFailure

Definition at line 72 of file ServiceException.cs.

Property Documentation

ErrorCode

string? Fauna.Exceptions.ServiceException.ErrorCode

get

The error code when a query fails.

Definition at line 25 of file ServiceException.cs.

QueryTags

IDictionary<string, string> Fauna.Exceptions.ServiceException.QueryTags

get

The tags on the x-query-tags header, if it was provided.

Definition at line 55 of file ServiceException.cs.

SchemaVersion

long? Fauna.Exceptions.ServiceException.SchemaVersion

get

The schema version used by the query. This can be used by clients displaying schema to determine when they should refresh their schema. If the schema version that a client has stored differs from the one returned by the query, schema should be refreshed.

Definition at line 50 of file ServiceException.cs.

Stats

QueryStats Fauna.Exceptions.ServiceException.Stats

get

The query stats for the request.

Definition at line 35 of file ServiceException.cs.

StatusCode

HttpStatusCode? Fauna.Exceptions.ServiceException.StatusCode

getset

The HTTP status code.

Definition at line 20 of file ServiceException.cs.

Summary

string? Fauna.Exceptions.ServiceException.Summary

get

A comprehensive, human readable summary of any errors, warnings and/or logs returned from the query.

Definition at line 30 of file ServiceException.cs.

TxnTs

long? Fauna.Exceptions.ServiceException.TxnTs

get

The transaction commit time in micros since epoch. Used by drivers to populate the x-last-txn-ts request header in order to get a consistent prefix RYOW guarantee.

Definition at line 42 of file ServiceException.cs.

---

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

• Fauna/Exceptions/ServiceException.cs