Skip to content

Module ogc_api_processes_client.exceptions

A sample API conforming to the OGC API - Processes - Part 1 standard

This document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application.

The version of the OpenAPI document: 1.0.0 Contact: standards-team@ogc.org Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Functions

render_path

def render_path(
    path_to_item
)

Returns a string representation of a path

Classes

ApiAttributeError

class ApiAttributeError(
    msg,
    path_to_item=None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.AttributeError
  • builtins.Exception
  • builtins.BaseException

Class variables

args

name

obj

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ApiException

class ApiException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Descendants

  • ogc_api_processes_client.exceptions.BadRequestException
  • ogc_api_processes_client.exceptions.NotFoundException
  • ogc_api_processes_client.exceptions.UnauthorizedException
  • ogc_api_processes_client.exceptions.ForbiddenException
  • ogc_api_processes_client.exceptions.ServiceException
  • ogc_api_processes_client.exceptions.ConflictException
  • ogc_api_processes_client.exceptions.UnprocessableEntityException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ApiKeyError

class ApiKeyError(
    msg,
    path_to_item=None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.KeyError
  • builtins.LookupError
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ApiTypeError

class ApiTypeError(
    msg,
    path_to_item=None,
    valid_classes=None,
    key_type=None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.TypeError
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ApiValueError

class ApiValueError(
    msg,
    path_to_item=None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.ValueError
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

BadRequestException

class BadRequestException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ConflictException

class ConflictException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

Exception for HTTP 409 Conflict.

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ForbiddenException

class ForbiddenException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

NotFoundException

class NotFoundException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

OpenApiException

class OpenApiException(
    /,
    *args,
    **kwargs
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • builtins.Exception
  • builtins.BaseException

Descendants

  • ogc_api_processes_client.exceptions.ApiTypeError
  • ogc_api_processes_client.exceptions.ApiValueError
  • ogc_api_processes_client.exceptions.ApiAttributeError
  • ogc_api_processes_client.exceptions.ApiKeyError
  • ogc_api_processes_client.exceptions.ApiException

Class variables

args

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

ServiceException

class ServiceException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

UnauthorizedException

class UnauthorizedException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

The base exception class for all OpenAPIExceptions

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.

UnprocessableEntityException

class UnprocessableEntityException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None
)

Exception for HTTP 422 Unprocessable Entity.

Ancestors (in MRO)

  • ogc_api_processes_client.exceptions.ApiException
  • ogc_api_processes_client.exceptions.OpenApiException
  • builtins.Exception
  • builtins.BaseException

Class variables

args

Static methods

from_response

def from_response(
    *,
    http_resp,
    body: str | None,
    data: Any | None
) -> Self

Methods

add_note

def add_note(
    self,
    note,
    /
)

Add a note to the exception

with_traceback

def with_traceback(
    self,
    tb,
    /
)

Set self.traceback to tb and return self.