heimdall package

Subpackages

Submodules

heimdall.heimdall_client module

class heimdall.heimdall_client.HeimdallClient(base_url, apikey, client=None)[source]

Bases: object

apikey

Initialize the HeimdallClient.

This class provides a client to interact with various API endpoints related to Heimdall.

Parameters:
  • base_url (str) – The base URL of the Heimdall API.

  • apikey (str) – The API key for authentication with the Heimdall API.

  • client (object, optional) – An instance of the HTTP client to use for making API requests (default is None).

secret_api

An instance of SecretApi for interacting with the Secret API endpoints.

Type:

SecretApi

user_api

An instance of UserApi for interacting with the User API endpoints.

Type:

UserApi

data_policy_api

An instance of DataPolicyApi for interacting with the Data Policy API endpoints.

Type:

DataPolicyApi

class heimdall.heimdall_client.HeimdallClientBuilder[source]

Bases: BaseHTTPClientBuilder

build()[source]

Build the HeimdallClient instance.

Returns:

An instance of HeimdallClient with the configured settings.

Return type:

HeimdallClient

get_default_user_agent_suffix()[source]

Module contents