| |
Class methods defined here:
- check_and_create_folder(folder_path: str) -> None
- Check if a folder exists and create it if it does not.
:param folder_path: The path of the folder to check/create.
:raises OSError: If the folder cannot be created or is not a directory.
- check_ias_folders() -> bool
- Check and create the IAS folders if they do not exist.
This includes logs, tmp, and config folders.
:return: True if all folders are checked and created successfully.
- get_ias_config_folder() -> str
- Get the IAS configuration folder from the environment or default.
:return: The IAS configuration folder path from the environment or the default
- get_ias_config_var_name() -> str
- Get the IAS configuration environment variable name.
:return: The IAS configuration environment variable name.
- get_ias_logs_folder() -> str | None
- Get the IAS logs folder from the environment or one of the default
folders in cls._alternative_log_folder
:return: The IAS logs folder path from the environment or the default;
None if no suitable folder has been found
- get_ias_logs_var_name() -> str
- Get the IAS logs environment variable name.
:return: The IAS logs folder path.
- get_ias_root_folder() -> str
- Get the IAS root folder from the environment or default.
:return: The IAS root folder path from the environment or the default
- get_ias_root_var_name() -> str
- Get the IAS root environment variable name.
:return: The IAS root environment variable name.
- get_ias_tmp_folder() -> str
- Get the IAS temporary folder from the environment or default.
:return: The IAS temporary folder path from the environment or the default
- get_ias_tmp_var_name() -> str
- Get the IAS temporary environment variable name.
:return: The IAS tmp environment variable name.
- get_kafka_home_folder() -> str
- Get the Kafka home folder from the environment or default.
:return: The Kafka home folder path from the environment or the default
- get_kafka_home_var_name() -> str
- Get the Kafka home environment variable name.
:return: The Kafka home environment variable name.
Data descriptors defined here:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Data and other attributes defined here:
- __annotations__ = {'_alternative_logs_folders': list[str], '_default_ias_config_folder': <class 'str'>, '_default_ias_logs_folder': <class 'str'>, '_default_ias_root_folder': <class 'str'>, '_default_ias_tmp_folder': <class 'str'>, '_default_kafka_home_folder': <class 'str'>, '_ias_config_env_var': <class 'str'>, '_ias_logs_env_var': <class 'str'>, '_ias_root_env_var': <class 'str'>, '_ias_tmp_env_var': <class 'str'>, ...}
|