ai_api_client_sdk.exception
index
/home/jenkins/agent/workspace/ndation_ai-api-client-sdk_master/ai_api_client_sdk/exception.py

 
Classes
       
builtins.Exception(builtins.BaseException)
AIAPIClientSDKException
AIAPIAuthenticatorException
AIAPIAuthenticatorAuthorizationException
AIAPIAuthenticatorForbiddenException
AIAPIAuthenticatorInvalidRequestException
AIAPIAuthenticatorMethodNotAllowedException
AIAPIAuthenticatorServerException
AIAPIAuthenticatorTimeoutException
AIAPIInvalidInputException
AIAPIRequestException
AIAPIServerException
AIAPIAuthorizationException
AIAPIInvalidRequestException
AIAPINotFoundException
AIAPIPreconditionFailedException

 
class AIAPIAuthenticatorAuthorizationException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorAuthorizationException(error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with unauthorized when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorAuthorizationException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorException(AIAPIClientSDKException)
    AIAPIAuthenticatorException(status_code: int = None, error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator`
 
 
Method resolution order:
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorForbiddenException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorForbiddenException(error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with forbidden when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorForbiddenException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorInvalidRequestException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorInvalidRequestException(error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with bad request when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorInvalidRequestException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorMethodNotAllowedException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorMethodNotAllowedException(error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with method not allowed when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorMethodNotAllowedException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorServerException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorServerException(status_code: int = None, error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with server error when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorServerException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthenticatorTimeoutException(AIAPIAuthenticatorException)
    AIAPIAuthenticatorTimeoutException(error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
the XSUAA server responded with request timeout when trying to retrieve a token
 
 
Method resolution order:
AIAPIAuthenticatorTimeoutException
AIAPIAuthenticatorException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIAuthorizationException(AIAPIServerException)
    AIAPIAuthorizationException(description: str, error_message: str, error_code: str = None, request_id: str = None, details: dict = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 401 response
is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
for object definition
 
 
Method resolution order:
AIAPIAuthorizationException
AIAPIServerException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, error_message: str, error_code: str = None, request_id: str = None, details: dict = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIServerException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIClientSDKException(builtins.Exception)
    AIAPIClientSDKException(description: str, status_code: int = None, error_message: str = None)
 
Base Exception class for AI API Client SDK exceptions
 
 
Method resolution order:
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIInvalidInputException(AIAPIClientSDKException)
    AIAPIInvalidInputException(description: str)
 
Exception type raised, when the provided input is invalid
 
 
Method resolution order:
AIAPIInvalidInputException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIInvalidRequestException(AIAPIServerException)
    AIAPIInvalidRequestException(description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 400 response
is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
for object definition
 
 
Method resolution order:
AIAPIInvalidRequestException
AIAPIServerException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIServerException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPINotFoundException(AIAPIServerException)
    AIAPINotFoundException(description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 404 response
is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
for object definition
 
 
Method resolution order:
AIAPINotFoundException
AIAPIServerException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIServerException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIPreconditionFailedException(AIAPIServerException)
    AIAPIPreconditionFailedException(description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 412 response
is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
for object definition
 
 
Method resolution order:
AIAPIPreconditionFailedException
AIAPIServerException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, error_code: str, error_message: str, request_id: str, details: dict = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIServerException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIRequestException(AIAPIClientSDKException)
    AIAPIRequestException(description: str, status_code: int = None, error_message: str = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if an unexpected
exception occurs while trying to send a request to the server
 
 
Method resolution order:
AIAPIRequestException
AIAPIClientSDKException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from AIAPIClientSDKException:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class AIAPIServerException(builtins.Exception)
    AIAPIServerException(description: str, status_code: int, error_message: str, error_code: str = None, request_id: str = None, details: dict = None)
 
Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient`, if a non-2XX
response is received from the server.
 
:param description: description of the exception
:type description: str
:param status_code: Status code of the response from the server
:type status_code: int
:param error_message: Error message received from the server
:type error_message: str
:param error_code: Error code received from the server, defaults to None
:type error_code: str, optional
:param request_id: ID of the request, the response belongs to, defaults to None
:type request_id: str, optional
:param details: Error details received from the server, defaults to None
:type details: dict, optional
 
 
Method resolution order:
AIAPIServerException
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, description: str, status_code: int, error_message: str, error_code: str = None, request_id: str = None, details: dict = None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args