ska_src_api_global_execution.models.execution_model

Model for execution

Module Contents

Classes

ExecutionErrorCode

Error codes for execution errors

ExecutionModel

Model for execution request

Attributes

MongoId

PyObjectId

class ska_src_api_global_execution.models.execution_model.ExecutionErrorCode

Bases: str, enum.Enum

digraph inheritanced99951c4f2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Create a collection of name/value pairs."]; "ExecutionErrorCode" [URL="#ska_src_api_global_execution.models.execution_model.ExecutionErrorCode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Error codes for execution errors"]; "Enum" -> "ExecutionErrorCode" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Error codes for execution errors

EXECUTION_FAILED = 'execution_failed'
INVALID_WORKSTEP = 'invalid_workstep'
PANDA_SERVER_CONNECTION_ERROR = 'panda_server_connection_error'
QUEUE_NOT_FOUND = 'queue_not_found'
UNKNOWN_ERROR = 'unknown_error'
class ska_src_api_global_execution.models.execution_model.ExecutionModel(/, **data)

Bases: pydantic.BaseModel

digraph inheritance504c1b42da { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "ExecutionModel" [URL="#ska_src_api_global_execution.models.execution_model.ExecutionModel",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Model for execution request"]; "BaseModel" -> "ExecutionModel" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Model for execution request

error: Annotated[Optional[str], Field(description='Error message if the execution failed', default=None)]
error_code: Annotated[Optional[ExecutionErrorCode], Field(description='Error code if the execution failed', default=None)]
id: MongoId
metadata: Annotated[Optional[dict], Field(description='Metadata for the execution, such as source of the request and method of submission', json_schema_extra={'examples': [{'queue_name': '', 'method': 'submit_job_endpoint'}]}, default_factory=dict)]
model_config
workstep: Annotated[ska_src_api_global_execution.models.workstep.WorkStepModelV1, Field(description='Workstep to be executed')]
ska_src_api_global_execution.models.execution_model.MongoId
ska_src_api_global_execution.models.execution_model.PyObjectId