Module ogc_api_processes_client.configuration

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.

Variables

JSON_SCHEMA_VALIDATION_KEYWORDS

ServerVariablesT

Classes

APIKeyAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

AuthSettings

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

BasicAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

BearerAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

BearerFormatAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

Configuration

class Configuration(
    host: str | None = None,
    api_key: Dict[str, str] | None = None,
    api_key_prefix: Dict[str, str] | None = None,
    username: str | None = None,
    password: str | None = None,
    access_token: str | None = None,
    server_index: int | None = None,
    server_variables: Dict[str, str] | None = None,
    server_operation_index: Dict[int, int] | None = None,
    server_operation_variables: Dict[int, Dict[str, str]] | None = None,
    ignore_operation_servers: bool = False,
    ssl_ca_cert: str | None = None,
    retries: int | None = None,
    ca_cert_data: str | bytes | None = None,
    *,
    debug: bool | None = None
)

This class contains various settings of the API client.

:param host: Base url. :param ignore_operation_servers Boolean to ignore operation servers for the API client. Config will use host as the base url regardless of the operation servers. :param api_key: Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret. :param api_key_prefix: Dict to store API prefix (e.g. Bearer). The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data. :param username: Username for HTTP basic authentication. :param password: Password for HTTP basic authentication. :param access_token: Access token. :param server_index: Index to servers configuration. :param server_variables: Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before. :param server_operation_index: Mapping from operation ID to an index to server configuration. :param server_operation_variables: Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before. :param ssl_ca_cert: str - the path to a file of concatenated CA certificates in PEM format. :param retries: Number of retries for API requests. :param ca_cert_data: verify the peer using concatenated CA certificate data in PEM (str) or DER (bytes) format.

Static methods

get_default

def get_default(

) -> Self

Return the default configuration.

This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default configuration.

Returns:

Type	Description
None	The configuration object.

get_default_copy

def get_default_copy(

) -> Self

Deprecated. Please use get_default instead.

Deprecated. Please use get_default instead.

Returns:

Type	Description
None	The configuration object.

set_default

def set_default(
    default: Self | None
) -> None

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters:

Name	Type	Description	Default
default	None	object of Configuration	None

Instance variables

debug

Debug status

host

Return generated host.

logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Methods

auth_settings

def auth_settings(
    self
) -> ogc_api_processes_client.configuration.AuthSettings

Gets Auth Settings dict for api client.

Returns:

Type	Description
None	The Auth Settings information dict.

get_api_key_with_prefix

def get_api_key_with_prefix(
    self,
    identifier: str,
    alias: str | None = None
) -> str | None

Gets API key (with prefix if set).

Parameters:

Name	Type	Description	Default
identifier	None	The identifier of apiKey.	None
alias	None	The alternative identifier of apiKey.	None

Returns:

Type	Description
None	The token for api key authentication.

get_basic_auth_token

def get_basic_auth_token(
    self
) -> str | None

Gets HTTP basic authentication header (string).

Returns:

Type	Description
None	The token for basic HTTP authentication.

get_host_from_settings

def get_host_from_settings(
    self,
    index: int | None,
    variables: Dict[str, str] | None = None,
    servers: List[ogc_api_processes_client.configuration.HostSetting] | None = None
) -> str

Gets host URL based on the index and variables

Parameters:

Name	Type	Description	Default
index	None	array index of the host settings	None
variables	None	hash of variable and the corresponding value	None
servers	None	an array of host settings or None	None

Returns:

Type	Description
None	URL based on host settings

get_host_settings

def get_host_settings(
    self
) -> List[ogc_api_processes_client.configuration.HostSetting]

Gets an array of host settings

Returns:

Type	Description
None	An array of host settings

to_debug_report

def to_debug_report(
    self
) -> str

Gets the essential information for debugging.

Returns:

Type	Description
None	The report for debugging.

GenericAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

HTTPSignatureAuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

HostSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

HostSettingVariable

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.

OAuth2AuthSetting

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

dict() -> new empty dictionary

dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

• builtins.dict

Methods

clear

def clear(
    self,
    /
)

Remove all items from the dict.

copy

def copy(
    self,
    /
)

Return a shallow copy of the dict.

fromkeys

def fromkeys(
    iterable,
    value=None,
    /
)

Create a new dictionary with keys from iterable and values set to value.

get

def get(
    self,
    key,
    default=None,
    /
)

Return the value for key if key is in the dictionary, else default.

items

def items(
    self,
    /
)

Return a set-like object providing a view on the dict's items.

keys

def keys(
    self,
    /
)

Return a set-like object providing a view on the dict's keys.

pop

def pop(
    ...
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem

def popitem(
    self,
    /
)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault

def setdefault(
    self,
    key,
    default=None,
    /
)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update

def update(
    ...
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

def values(
    self,
    /
)

Return an object providing a view on the dict's values.