Common

The common package contains settings parameters and error exceptions.

Common.exception

Common.settings

class firebolt.common.settings.Settings(_env_file: Optional[Union[str, PathLike]] = '<object object>', _env_file_encoding: Optional[str] = None, _env_nested_delimiter: Optional[str] = None, _secrets_dir: Optional[Union[str, PathLike]] = None, *, auth: Auth = None, user: str = None, password: SecretStr = None, access_token: str = None, account_name: str = None, server: str, default_region: str, use_token_cache: bool = True)

Bases: BaseSettings

Settings for Firebolt SDK.

user

User name

Type: Optional[str]

password

User password

Type: Optional[str]

access_token

Access token to use for authentication. Mutually exclusive with user and password

Type: Optional[str]

account_name

Account name. Default user account is used if none provided

Type: Optional[str]

server

Environment api endpoint (Advanced). Default api endpoint is used if none provided

Type: Optional[str]

default_region

Default region for provisioning

Type: str

class Config

Bases: object

Internal pydantic config.

env_file = '.env'

access_token: str

account_name: str

auth: Auth

default_region: str

classmethod mutual_exclusive_with_creds(values: dict) → dict

Validate that either creds or token is provided.

Parameters: values (dict) – settings initial values
Returns: Validated settings values
Return type: dict
Raises: ValueError – Either both or none of credentials and token are provided

password: SecretStr

server: str

use_token_cache: bool

user: str

Common

Common.exception

Common.settings

Common.urls

Common.token_storage

Common.util