ds_provider_xledger_py_lib.errors
=================================

.. py:module:: ds_provider_xledger_py_lib.errors

.. autoapi-nested-parse::

   **File:** ``errors.py``
   **Region:** ``ds_provider_xledger_py_lib``

   Description
   -----------
   Xledger-specific exceptions.



Exceptions
----------

.. autoapisummary::

   ds_provider_xledger_py_lib.errors.InvalidQueryException
   ds_provider_xledger_py_lib.errors.InvalidMutationException
   ds_provider_xledger_py_lib.errors.OutOfCreditException
   ds_provider_xledger_py_lib.errors.TimeOutException
   ds_provider_xledger_py_lib.errors.ConcurrentRequestException
   ds_provider_xledger_py_lib.errors.BurstRequestException
   ds_provider_xledger_py_lib.errors.UnhandledXledgerException


Module Contents
---------------

.. py:exception:: InvalidQueryException(message: str = 'Invalid Xledger Query.', code: str = 'DS_XLEDGER_INVALID_QUERY_ERROR', status_code: int = 400, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.ReadError`


   Raised when a GraphQL query is invalid.


.. py:exception:: InvalidMutationException(message: str = 'Invalid Xledger Mutation.', code: str = 'DS_XLEDGER_INVALID_MUTATION_ERROR', status_code: int = 400, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.CreateError`, :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.UpdateError`


   Raised when a GraphQL mutation is invalid.


.. py:exception:: OutOfCreditException(message: str = 'User is out of credits in Xledger.', code: str = 'DS_XLEDGER_OUT_OF_CREDIT_ERROR', status_code: int = 400, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.DatasetException`


   Raised when the user has no available Xledger credits.


.. py:exception:: TimeOutException(message: str = 'Request timed out.', code: str = 'DS_XLEDGER_TIMEOUT_ERROR', status_code: int = 408, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.DatasetException`


   Raised when the request times out.


.. py:exception:: ConcurrentRequestException(message: str = 'Too many concurrent requests.', code: str = 'DS_XLEDGER_CONCURRENT_REQUEST_ERROR', status_code: int = 429, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.DatasetException`


   Raised when there are too many concurrent requests.


.. py:exception:: BurstRequestException(message: str = 'Too many requests.', code: str = 'DS_XLEDGER_BURST_REQUEST_ERROR', status_code: int = 429, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.DatasetException`


   Raised when request burst/rate limit is exceeded.


.. py:exception:: UnhandledXledgerException(message: str = 'Unhandled Xledger exception occurred.', code: str = 'DS_XLEDGER_UNHANDLED_ERROR', status_code: int = 500, details: dict[str, Any] | None = None)

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.errors.DatasetException`


   Raised when an unclassified Xledger exception occurs.