Fauna v10 .NET/C# Driver 0.2.0-beta
 
Loading...
Searching...
No Matches
Fauna.Exceptions.AbortException Class Reference

Represents an exception that occurs when the FQL abort function is called. This exception captures the data provided during the abort operation. More...

Inheritance diagram for Fauna.Exceptions.AbortException:
Fauna.Exceptions.ServiceException Fauna.Exceptions.FaunaException

Public Member Functions

 AbortException (string message, QueryFailure failure, MappingContext ctx)
 Initializes a new instance of the AbortException class with a specified error message and query failure details.
 
object? GetData ()
 Retrieves the deserialized data associated with the abort operation as an object.
 
T? GetData< T > ()
 Retrieves the deserialized data associated with the abort operation as a specific type.
 
T? GetData< T > (ISerializer< T > serializer)
 Retrieves the deserialized data associated with the abort operation as a specific type.
 
- Public Member Functions inherited from Fauna.Exceptions.ServiceException
 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)
 

Additional Inherited Members

- Properties inherited from Fauna.Exceptions.ServiceException
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 that occurs when the FQL abort function is called. This exception captures the data provided during the abort operation.

Definition at line 89 of file ServiceException.cs.

Constructor & Destructor Documentation

◆ AbortException()

Fauna.Exceptions.AbortException.AbortException ( string message,
QueryFailure failure,
MappingContext ctx )

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

Parameters
messageThe error message that explains the reason for the exception.
failureA QueryFailure
ctxA mapping context.

Definition at line 102 of file ServiceException.cs.

Member Function Documentation

◆ GetData()

object? Fauna.Exceptions.AbortException.GetData ( )

Retrieves the deserialized data associated with the abort operation as an object.

Returns
The deserialized data as an object, or null if no data is available.

◆ GetData< T >() [1/2]

Retrieves the deserialized data associated with the abort operation as a specific type.

Template Parameters
TThe type to which the data should be deserialized.
Returns
The deserialized data as the specified type, or null if no data is available.
Type Constraints
T :notnull 

◆ GetData< T >() [2/2]

Retrieves the deserialized data associated with the abort operation as a specific type.

Template Parameters
TThe type to which the data should be deserialized.
Parameters
serializerA serializer for the abort data.
Returns
The deserialized data as the specified type, or null if no data is available.

Definition at line 128 of file ServiceException.cs.


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