Types

flame_hub._base_client.ResourceT = typing.TypeVar

Base resource type which assumes BaseModel as the base class.

flame_hub.types.FilterParams

alias of dict[str, Any | tuple[FilterOperator, Any]]

flame_hub.types.FieldParams

alias of str | Iterable[str]

flame_hub.types.IncludeParams

alias of str | Iterable[str]

flame_hub.types.RegistryCommand

alias of Literal[‘setup’, ‘cleanup’]

flame_hub.types.NodeType

alias of Literal[‘aggregator’, ‘default’]

flame_hub.types.RegistryProjectType

alias of Literal[‘default’, ‘aggregator’, ‘incoming’, ‘outgoing’, ‘masterImages’, ‘node’]

flame_hub.types.ProjectNodeApprovalStatus

alias of Literal[‘rejected’, ‘approved’]

flame_hub.types.AnalysisBuildStatus

alias of Literal[‘starting’, ‘started’, ‘stopping’, ‘stopped’, ‘finished’, ‘failed’]

flame_hub.types.AnalysisRunStatus

alias of Literal[‘starting’, ‘started’, ‘running’, ‘stopping’, ‘stopped’, ‘finished’, ‘failed’]

flame_hub.types.AnalysisCommand

alias of Literal[‘spinUp’, ‘tearDown’, ‘buildStart’, ‘buildStop’, ‘configurationLock’, ‘configurationUnlock’, ‘buildStatus’]

flame_hub.types.AnalysisNodeApprovalStatus

alias of Literal[‘rejected’, ‘approved’]

flame_hub.types.AnalysisNodeRunStatus

alias of Literal[‘starting’, ‘started’, ‘stopping’, ‘stopped’, ‘running’, ‘finished’, ‘failed’]

flame_hub.types.AnalysisBucketType

alias of Literal[‘CODE’, ‘RESULT’, ‘TEMP’]

class flame_hub.types.PageParams

Bases: TypedDict

Dict shape for specifying limit and offset for paginated queries.

See also

FindAllKwargs, _find_all_resources()

limit: int

Amount of returned resources.

offset: int

Amount of resources to skip before resources are added to the returned list.

class flame_hub.types.SortParams

Bases: TypedDict

Dict shape for specifying parameters for sorted queries.

See also

FindAllKwargs, _find_all_resources()

by: str

Name of the attribute to sort by.

order: Literal['ascending', 'descending']

Sort in either ascending or descending order.

class flame_hub.types.FilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Operators that are supported by the Hub API for filtering requests.

See also

FilterParams, FindAllKwargs, _find_all_resources()

eq = '='

neq = '!'

like = '~'

lt = '<'

le = '<='

gt = '>'

ge = '>='

class flame_hub.types.FindAllKwargs

Bases: TypedDict

Keyword arguments that can be used for finding resources.

See also

FilterOperator, FilterParams, PageParams, SortParams, flame_hub.types.FieldParams, _find_all_resources()

filter: FilterParams | None

page: PageParams | None

sort: SortParams | None

fields: FieldParams | None

meta: bool

class flame_hub.types.GetKwargs

Bases: TypedDict

Keyword arguments that can be used for getting resources.

See also

FieldParams

fields: FieldParams | None

meta: bool

class flame_hub.types.MasterImageCommandArgument

Bases: TypedDict

value: str

position: Literal['before', 'after'] | None

class flame_hub.types.UploadFile

Bases: TypedDict

file_name: str

content: bytes | IO[bytes] | str

content_type: NotRequired[str]

class flame_hub._base_client.UuidModel(*args, **kwargs)

Bases: Protocol[ResourceT]

Structural subtype which expects a BaseModel to have an id attribute.

id: UUID

flame_hub.types.UuidIdentifiable

alias of UuidModel | UUID | str

class flame_hub._base_client.ClientKwargs

Bases: TypedDict

Keyword arguments that can be used to instantiate a client.

See also

BaseClient, AuthClient, CoreClient, StorageClient

client: Client | None