Models

class flame_hub._base_client._UNSET

Bases: object

Sentinel to mark parameters as unset as opposed to using None.

class flame_hub.models.CreateNode(*, external_name: str | None, hidden: bool | None, name: str, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], registry_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], type: Literal['aggregator', 'default'] | None)

Bases: BaseModel

external_name: str | None
hidden: bool | None
name: str
realm_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
registry_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
type: NodeType | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Node(*, external_name: str | None, hidden: bool | None, name: str, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], registry_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], type: Literal['aggregator', 'default'] | None, id: UUID, public_key: str | None, online: bool, registry: Registry | None = None, registry_project_id: UUID | None, registry_project: RegistryProject | None = None, robot_id: UUID, created_at: datetime, updated_at: datetime)

Bases: CreateNode

id: uuid.UUID
public_key: str | None
online: bool
registry: Registry | None
registry_project_id: uuid.UUID | None
registry_project: RegistryProject | None
robot_id: uuid.UUID
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateNode(*, hidden: bool | None = None, external_name: str | None = None, type: Literal['aggregator', 'default'] | None = None, public_key: str | None = None, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None, registry_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None)

Bases: UpdateModel

hidden: bool | None
external_name: str | None
type: NodeType | None
public_key: str | None
realm_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
registry_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.MasterImageGroup(*, id: UUID, name: str, path: str, virtual_path: str, created_at: datetime, updated_at: datetime)

Bases: BaseModel

id: uuid.UUID
name: str
path: str
virtual_path: str
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.MasterImage(*, id: UUID, path: str | None, virtual_path: str, group_virtual_path: str, name: str, command: str | None, command_arguments: Annotated[list[MasterImageCommandArgument] | None, BeforeValidator(func=ensure_position_none, json_schema_input_type=PydanticUndefined)], created_at: datetime, updated_at: datetime)

Bases: BaseModel

id: uuid.UUID
path: str | None
virtual_path: str
group_virtual_path: str
name: str
command: str | None
command_arguments: t.Annotated[list[MasterImageCommandArgument] | None, BeforeValidator(ensure_position_none)]
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateProjectNode(*, node_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], project_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

node_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
project_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateProject(*, description: str | None, master_image_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], name: str)

Bases: BaseModel

description: str | None
master_image_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
name: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Project(*, description: str | None, master_image_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], name: str, id: UUID, analyses: int, nodes: int, master_image: MasterImage | None = None, created_at: datetime, updated_at: datetime, realm_id: UUID, user_id: UUID | None, robot_id: UUID | None)

Bases: CreateProject

id: uuid.UUID
analyses: int
nodes: int
master_image: MasterImage | None
created_at: datetime
updated_at: datetime
realm_id: uuid.UUID
user_id: uuid.UUID | None
robot_id: uuid.UUID | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateProject(*, description: str | None = None, master_image_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None, name: str | None = None)

Bases: UpdateModel

description: str | None
master_image_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
name: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.ProjectNode(*, node_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], project_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, approval_status: Literal['rejected', 'approved'], comment: str | None, created_at: datetime, updated_at: datetime, node: Node = None, project: Project = None, project_realm_id: UUID, node_realm_id: UUID)

Bases: CreateProjectNode

id: uuid.UUID
approval_status: ProjectNodeApprovalStatus
comment: str | None
created_at: datetime
updated_at: datetime
node: Node
project: Project
project_realm_id: uuid.UUID
node_realm_id: uuid.UUID
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateAnalysis(*, description: str | None, name: str | None, project_id: ~typing.Annotated[~uuid.UUID, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)], master_image_id: ~typing.Annotated[~uuid.UUID | None, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)], registry_id: ~typing.Annotated[~uuid.UUID | None, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)], image_command_arguments: ~typing.Annotated[list[~flame_hub._core_client.MasterImageCommandArgument], ~pydantic.functional_validators.BeforeValidator(func=~flame_hub._core_client.<lambda>, json_schema_input_type=PydanticUndefined)] = <factory>)

Bases: BaseModel

description: str | None
name: str | None
project_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
master_image_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
registry_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
image_command_arguments: t.Annotated[list[MasterImageCommandArgument], Field(default_factory=list), BeforeValidator(lambda value: [] if value is None else value)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Analysis(*, description: str | None, name: str | None, project_id: ~uuid.UUID, master_image_id: ~typing.Annotated[~uuid.UUID | None, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)], registry_id: ~typing.Annotated[~uuid.UUID | None, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)], image_command_arguments: ~typing.Annotated[list[~flame_hub._core_client.MasterImageCommandArgument], ~pydantic.functional_validators.BeforeValidator(func=~flame_hub._core_client.<lambda>, json_schema_input_type=PydanticUndefined)] = <factory>, id: ~uuid.UUID, configuration_locked: bool, nodes: int, build_status: ~typing.Literal['starting', 'started', 'stopping', 'stopped', 'finished', 'failed'] | None, run_status: ~typing.Literal['starting', 'started', 'running', 'stopping', 'stopped', 'finished', 'failed'] | None, created_at: ~datetime.datetime, updated_at: ~datetime.datetime, registry: ~flame_hub._core_client.Registry | None = None, realm_id: ~uuid.UUID, user_id: ~uuid.UUID, project: ~flame_hub._core_client.Project = None, master_image: ~flame_hub._core_client.MasterImage | None = None)

Bases: CreateAnalysis

id: uuid.UUID
configuration_locked: bool
nodes: int
build_status: AnalysisBuildStatus | None
run_status: AnalysisRunStatus | None
created_at: datetime
updated_at: datetime
registry: Registry | None
realm_id: uuid.UUID
user_id: uuid.UUID
project_id: uuid.UUID
project: Project
master_image: MasterImage | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateAnalysis(*, description: str | None = None, name: str | None = None, master_image_id: ~typing.Annotated[~uuid.UUID | None, ~pydantic.functional_validators.WrapValidator(func=~flame_hub._base_client.uuid_validator, json_schema_input_type=PydanticUndefined)] = None, image_command_arguments: list[~flame_hub._core_client.MasterImageCommandArgument] = <factory>)

Bases: UpdateModel

description: str | None
name: str | None
master_image_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
image_command_arguments: t.Annotated[list[MasterImageCommandArgument], Field(default_factory=list)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateAnalysisNode(*, analysis_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], node_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

analysis_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
node_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AnalysisNode(*, analysis_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], node_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, approval_status: Literal['rejected', 'approved'] | None, run_status: Literal['starting', 'started', 'running', 'stopping', 'stopped', 'finished', 'failed'] | None, comment: str | None, index: int, artifact_tag: str | None, artifact_digest: str | None, created_at: datetime, updated_at: datetime, analysis: Analysis = None, node: Node = None, analysis_realm_id: UUID, node_realm_id: UUID)

Bases: CreateAnalysisNode

id: uuid.UUID
approval_status: AnalysisNodeApprovalStatus | None
run_status: AnalysisNodeRunStatus | None
comment: str | None
index: int
artifact_tag: str | None
artifact_digest: str | None
created_at: datetime
updated_at: datetime
analysis: Analysis
node: Node
analysis_realm_id: uuid.UUID
node_realm_id: uuid.UUID
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateAnalysisNode(*, comment: str | None = None, approval_status: Literal['rejected', 'approved'] | None = None, run_status: Literal['starting', 'started', 'running', 'stopping', 'stopped', 'finished', 'failed'] | None = None)

Bases: UpdateModel

comment: str | None
approval_status: AnalysisNodeApprovalStatus | None
run_status: AnalysisNodeRunStatus | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateAnalysisNodeLog(*, analysis_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], node_id: UUID, error: bool, error_code: str | None, status: str, status_message: str | None)

Bases: BaseModel

analysis_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
node_id: uuid.UUID
error: bool
error_code: str | None
status: str
status_message: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AnalysisNodeLog(*, analysis_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], node_id: UUID, error: bool, error_code: str | None, status: str, status_message: str | None, id: UUID, created_at: datetime, updated_at: datetime, analysis: Analysis = None, node: Node = None, analysis_realm_id: UUID, node_realm_id: UUID)

Bases: CreateAnalysisNodeLog

id: uuid.UUID
created_at: datetime
updated_at: datetime
analysis: Analysis
node: Node
analysis_realm_id: uuid.UUID
node_realm_id: uuid.UUID
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateAnalysisNodeLog(*, error: bool | None = None, error_code: str | None = None, status: str | None = None, status_message: str | None = None)

Bases: UpdateModel

error: bool | None
error_code: str | None
status: str | None
status_message: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AnalysisBucket(*, id: UUID, type: Literal['CODE', 'RESULT', 'TEMP'], external_id: UUID | None, created_at: datetime, updated_at: datetime, analysis_id: UUID, analysis: Analysis = None, realm_id: UUID)

Bases: BaseModel

id: uuid.UUID
type: AnalysisBucketType
external_id: uuid.UUID | None
created_at: datetime
updated_at: datetime
analysis_id: uuid.UUID
analysis: Analysis
realm_id: uuid.UUID
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateAnalysisBucketFile(*, name: str, external_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], bucket_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], root: bool)

Bases: BaseModel

name: str
external_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
bucket_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
root: bool
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AnalysisBucketFile(*, name: str, external_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], bucket_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], root: bool, id: UUID, created_at: datetime, updated_at: datetime, realm_id: UUID, user_id: UUID | None, robot_id: UUID | None, analysis_id: UUID, analysis: Analysis = None, bucket: AnalysisBucket = None)

Bases: CreateAnalysisBucketFile

id: uuid.UUID
created_at: datetime
updated_at: datetime
realm_id: uuid.UUID
user_id: uuid.UUID | None
robot_id: uuid.UUID | None
analysis_id: uuid.UUID
analysis: Analysis
bucket: AnalysisBucket
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateAnalysisBucketFile(*, root: bool | None = None)

Bases: UpdateModel

root: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRegistry(*, name: str, host: str, account_name: str | None, account_secret: Annotated[str | None, IsField] = None)

Bases: BaseModel

name: str
host: str
account_name: str | None
account_secret: t.Annotated[str | None, IsField]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Registry(*, name: str, host: str, account_name: str | None, account_secret: Annotated[str | None, IsField] = None, id: UUID, created_at: datetime, updated_at: datetime)

Bases: CreateRegistry

id: uuid.UUID
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateRegistry(*, name: str | None = None, host: str | None = None, account_name: str | None = None, account_secret: str | None = None)

Bases: UpdateModel

name: str | None
host: str | None
account_name: str | None
account_secret: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRegistryProject(*, name: str, type: Literal['default', 'aggregator', 'incoming', 'outgoing', 'masterImages', 'node'], registry_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], external_name: str)

Bases: BaseModel

name: str
type: RegistryProjectType
registry_id: t.Annotated[uuid.UUID, Field(), WrapValidator(uuid_validator)]
external_name: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.RegistryProject(*, name: str, type: Literal['default', 'aggregator', 'incoming', 'outgoing', 'masterImages', 'node'], registry_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], external_name: str, id: UUID, public: bool, external_id: str | None, webhook_name: str | None, webhook_exists: bool | None, realm_id: UUID | None, registry: Registry = None, account_id: Annotated[str | None, IsField] = None, account_name: Annotated[str | None, IsField] = None, account_secret: Annotated[str | None, IsField] = None, created_at: datetime, updated_at: datetime)

Bases: CreateRegistryProject

id: uuid.UUID
public: bool
external_id: str | None
webhook_name: str | None
webhook_exists: bool | None
realm_id: uuid.UUID | None
registry: Registry
account_id: t.Annotated[str | None, IsField]
account_name: t.Annotated[str | None, IsField]
account_secret: t.Annotated[str | None, IsField]
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateRegistryProject(*, name: str | None = None, type: Literal['default', 'aggregator', 'incoming', 'outgoing', 'masterImages', 'node'] | None = None, registry_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None, external_name: str | None = None)

Bases: UpdateModel

name: str | None
type: RegistryProjectType | None
registry_id: t.Annotated[uuid.UUID | None, Field(), WrapValidator(uuid_validator)]
external_name: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.MasterImageEventLog(*, id: UUID, name: str, data: dict | None = None, expiring: bool, expires_at: datetime, master_image_id: UUID | None, master_image: MasterImage | None = None, created_at: datetime, updated_at: datetime)

Bases: BaseModel

id: uuid.UUID
name: str
data: dict | None
expiring: bool
expires_at: datetime
master_image_id: uuid.UUID | None
master_image: MasterImage | None
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateBucket(*, name: str, region: str | None)

Bases: BaseModel

name: str
region: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.BucketFile(*, id: UUID, name: str, path: str, hash: str, directory: str, size: int | None, created_at: datetime, updated_at: datetime, actor_type: str, actor_id: UUID, bucket_id: UUID, bucket: Bucket = None)

Bases: BaseModel

id: UUID
name: str
path: str
hash: str
directory: str
size: int | None
created_at: datetime
updated_at: datetime
actor_type: str
actor_id: UUID
bucket_id: UUID
bucket: Bucket
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Bucket(*, name: str, region: str | None, id: UUID, created_at: datetime, updated_at: datetime, actor_id: UUID, actor_type: str, realm_id: UUID | None)

Bases: CreateBucket

id: UUID
created_at: datetime
updated_at: datetime
actor_id: UUID
actor_type: str
realm_id: UUID | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateModel

Bases: BaseModel

Base class for models that shall validate responses for requests that update resources.

This base class is needed so that properties can be unset when passed into the class constructor. Before validation, this class prunes all properties which have the _UNSET sentinel assigned to them. This way, they are considered unset by the base model.

classmethod strip_unset_properties(data: Any) Any

Strips unset properties before validating property values.

To strip all properties that have the _UNSET sentinel assigned to them, this class method is decorated with Pydantic’s model validator pydantic.model_validator() with mode="before" so that properties are stripped before validation to avoid validation errors. If data is a dictionary, then its keys are property names and values are the corresponding property values.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

flame_hub.models.UNSET

alias of _UNSET

class flame_hub.models.CreateRealm(*, name: str, display_name: str | None, description: str | None)

Bases: BaseModel

name: str
display_name: str | None
description: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateRealm(*, name: str | None = None, display_name: str | None = None, description: str | None = None)

Bases: UpdateModel

name: str | None
display_name: str | None
description: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Realm(*, name: str, display_name: str | None, description: str | None, id: UUID, built_in: bool, created_at: datetime, updated_at: datetime)

Bases: CreateRealm

id: UUID
built_in: bool
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRobot(*, name: str, realm_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], secret: Annotated[str, IsField] = None, display_name: str | None)

Bases: BaseModel

name: str
realm_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
secret: Annotated[str, IsField]
display_name: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Robot(*, name: str, realm_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], secret: Annotated[str, IsField] = None, display_name: str | None, id: UUID, description: str | None, active: bool, created_at: datetime, updated_at: datetime, user_id: UUID | None, user: User | None = None, realm: Realm = None)

Bases: CreateRobot

id: UUID
description: str | None
active: bool
created_at: datetime
updated_at: datetime
user_id: UUID | None
user: User | None
realm: Realm
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateRobot(*, display_name: str | None = None, name: str | None = None, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None, secret: str | None = None)

Bases: UpdateModel

display_name: str | None
name: str | None
realm_id: Annotated[UUID | None, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
secret: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreatePermission(*, name: str, display_name: str | None, description: str | None, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], policy_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

name: str
display_name: str | None
description: str | None
realm_id: Annotated[UUID | None, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
policy_id: Annotated[UUID | None, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Permission(*, name: str, display_name: str | None, description: str | None, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], policy_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, built_in: bool, client_id: UUID | None, created_at: datetime, updated_at: datetime, realm: Realm | None = None)

Bases: CreatePermission

id: UUID
built_in: bool
client_id: UUID | None
created_at: datetime
updated_at: datetime
realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdatePermission(*, name: str | None = None, display_name: str | None = None, description: str | None = None, realm_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None, policy_id: Annotated[UUID | None, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)] = None)

Bases: UpdateModel

name: str | None
display_name: str | None
description: str | None
realm_id: Annotated[UUID | None, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
policy_id: Annotated[UUID | None, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRole(*, name: str, display_name: str | None, description: str | None)

Bases: BaseModel

name: str
display_name: str | None
description: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.Role(*, name: str, display_name: str | None, description: str | None, id: UUID, target: str | None, realm_id: UUID | None, created_at: datetime, updated_at: datetime, realm: Realm | None = None)

Bases: CreateRole

id: UUID
target: str | None
realm_id: UUID | None
created_at: datetime
updated_at: datetime
realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateRole(*, name: str | None = None, display_name: str | None = None, description: str | None = None)

Bases: UpdateModel

name: str | None
display_name: str | None
description: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRolePermission(*, role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

role_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
permission_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.RolePermission(*, role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, role_realm_id: UUID | None, permission_realm_id: UUID | None, policy_id: UUID | None, created_at: datetime, updated_at: datetime, role: Role = None, role_realm: Realm | None = None, permission: Permission = None, permission_realm: Realm | None = None)

Bases: CreateRolePermission

id: UUID
role_realm_id: UUID | None
permission_realm_id: UUID | None
policy_id: UUID | None
created_at: datetime
updated_at: datetime
role: Role
role_realm: Realm | None
permission: Permission
permission_realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateUser(*, name: str, display_name: str | None, email: Annotated[str | None, IsField], active: bool, name_locked: bool, first_name: str | None, last_name: str | None, password: str | None)

Bases: BaseModel

name: str
display_name: str | None
email: Annotated[str | None, IsField]
active: bool
name_locked: bool
first_name: str | None
last_name: str | None
password: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.User(*, id: UUID, name: str, active: bool, name_locked: bool, email: Annotated[str | None, IsField] = None, display_name: str | None, first_name: str | None, last_name: str | None, avatar: str | None, cover: str | None, realm_id: UUID, realm: Realm = None, created_at: datetime, updated_at: datetime)

Bases: BaseModel

id: UUID
name: str
active: bool
name_locked: bool
email: Annotated[str | None, IsField]
display_name: str | None
first_name: str | None
last_name: str | None
avatar: str | None
cover: str | None
realm_id: UUID
realm: Realm
created_at: datetime
updated_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UpdateUser(*, name: str | None = None, display_name: str | None = None, email: str | None = None, active: bool | None = None, name_locked: bool | None = None, first_name: str | None = None, last_name: str | None = None, password: str | None = None)

Bases: UpdateModel

name: str | None
display_name: str | None
email: str | None
active: bool | None
name_locked: bool | None
first_name: str | None
last_name: str | None
password: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateUserPermission(*, user_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

user_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
permission_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UserPermission(*, user_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, user_realm_id: UUID | None, permission_realm_id: UUID | None, policy_id: UUID | None, created_at: datetime, updated_at: datetime, permission: Permission = None, user: User = None, permission_realm: Realm | None = None, user_realm: Realm | None = None)

Bases: CreateUserPermission

id: UUID
user_realm_id: UUID | None
permission_realm_id: UUID | None
policy_id: UUID | None
created_at: datetime
updated_at: datetime
permission: Permission
user: User
permission_realm: Realm | None
user_realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateUserRole(*, user_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

user_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
role_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.UserRole(*, user_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, user_realm_id: UUID | None, role_realm_id: UUID | None, created_at: datetime, updated_at: datetime, user: User = None, role: Role = None, user_realm: Realm | None = None, role_realm: Realm | None = None)

Bases: CreateUserRole

id: UUID
user_realm_id: UUID | None
role_realm_id: UUID | None
created_at: datetime
updated_at: datetime
user: User
role: Role
user_realm: Realm | None
role_realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRobotPermission(*, robot_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

robot_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
permission_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.RobotPermission(*, robot_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], permission_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, robot_realm_id: UUID | None, permission_realm_id: UUID | None, policy_id: UUID | None, created_at: datetime, updated_at: datetime, robot: Robot = None, permission: Permission = None, robot_realm: Realm | None = None, permission_realm: Realm | None = None)

Bases: CreateRobotPermission

id: UUID
robot_realm_id: UUID | None
permission_realm_id: UUID | None
policy_id: UUID | None
created_at: datetime
updated_at: datetime
robot: Robot
permission: Permission
robot_realm: Realm | None
permission_realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.CreateRobotRole(*, robot_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

robot_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
role_id: Annotated[UUID, FieldInfo(annotation=NoneType, required=True), WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.RobotRole(*, robot_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], role_id: Annotated[UUID, WrapValidator(func=uuid_validator, json_schema_input_type=PydanticUndefined)], id: UUID, robot_realm_id: UUID | None, role_realm_id: UUID | None, created_at: datetime, updated_at: datetime, robot: Robot = None, role: Role = None, robot_realm: Realm | None = None, role_realm: Realm | None = None)

Bases: CreateRobotRole

id: UUID
robot_realm_id: UUID | None
role_realm_id: UUID | None
created_at: datetime
updated_at: datetime
robot: Robot
role: Role
robot_realm: Realm | None
role_realm: Realm | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.IsField

Bases: object

Sentinel to annotate model attributes as optional fields.

class flame_hub.models.ResourceListMeta(*, total: int, **extra_data: Any)

Bases: BaseModel

Resource for meta information on list responses.

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}

Based on the type of the request, additional attributes like limit or offset may be available.

total: int

The total amount of records of a specific resource type.

class flame_hub.models.ResourceList(*, data: list[ResourceT], meta: ResourceListMeta)

Bases: BaseModel, Generic[ResourceT]

Resource for list responses.

data: list[ResourceT]

Attribute which holds all retrieved resources as a list.

meta: ResourceListMeta

Attribute which holds meta information about the result and the requested resource type.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AnalysisLog(*, id: UUID, component: str | None, command: str | None, event: str | None, error: bool, error_code: str | None, status: str | None, status_message: str | None, meta: str | None, created_at: datetime, updated_at: datetime, analysis_id: UUID, analysis: Analysis = None, realm_id: UUID)

Bases: BaseModel

id: uuid.UUID
component: str | None
command: str | None
event: str | None
error: bool
error_code: str | None
status: str | None
status_message: str | None
meta: str | None
created_at: datetime
updated_at: datetime
analysis_id: uuid.UUID
analysis: Analysis
realm_id: uuid.UUID
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.AccessToken(*, access_token: str, expires_in: int, token_type: str, scope: str)

Bases: BaseModel

access_token: str
expires_in: int
token_type: str
scope: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class flame_hub.models.RefreshToken(*, access_token: str, expires_in: int, token_type: str, scope: str, refresh_token: str)

Bases: AccessToken

refresh_token: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].