Schema

Use this class as a base model for automate related DTO.

model_config class-attribute instance-attribute

model_config = ConfigDict(
    alias_generator=to_camel, populate_by_name=True
)

Values of the project / model that triggered the run of this function.

project_id instance-attribute

project_id: str

speckle_server_url instance-attribute

speckle_server_url: str

automation_id instance-attribute

automation_id: str

automation_run_id instance-attribute

automation_run_id: str

function_run_id instance-attribute

function_run_id: str

triggers instance-attribute

triggers: list[VersionCreationTrigger]

model_config class-attribute instance-attribute

model_config = ConfigDict(
    alias_generator=to_camel,
    populate_by_name=True,
    protected_namespaces=(),
)

Schema accepted by the Speckle server as a result for an automation run.

elapsed class-attribute instance-attribute

elapsed: float = 0

result_view class-attribute instance-attribute

result_view: str | None = None

result_versions class-attribute instance-attribute

result_versions: list[str] = Field(default_factory=list)

blobs class-attribute instance-attribute

blobs: list[str] = Field(default_factory=list)

run_status class-attribute instance-attribute

run_status: AutomationStatus = RUNNING

status_message class-attribute instance-attribute

status_message: str | None = None

object_results class-attribute instance-attribute

object_results: list[ResultCase] = Field(
    default_factory=list
)

version_result class-attribute instance-attribute

version_result: dict[str, Any] | None = None

A result case.

category instance-attribute

category: str

level instance-attribute

level: ObjectResultLevel

object_app_ids instance-attribute

object_app_ids: dict[str, str | None]

message instance-attribute

message: str | None

metadata instance-attribute

metadata: dict[str, Any] | None

visual_overrides instance-attribute

visual_overrides: dict[str, Any] | None

Set the status of the automation.

INITIALIZING class-attribute instance-attribute

INITIALIZING = 'INITIALIZING'

RUNNING class-attribute instance-attribute

RUNNING = 'RUNNING'

FAILED class-attribute instance-attribute

FAILED = 'FAILED'

SUCCEEDED class-attribute instance-attribute

SUCCEEDED = 'SUCCEEDED'

EXCEPTION class-attribute instance-attribute

EXCEPTION = 'EXCEPTION'

Possible status message levels for object reports.

SUCCESS class-attribute instance-attribute

SUCCESS = 'SUCCESS'

INFO class-attribute instance-attribute

INFO = 'INFO'

WARNING class-attribute instance-attribute

WARNING = 'WARNING'

ERROR class-attribute instance-attribute

ERROR = 'ERROR'