qunicorn_core.api.api_models.job_dtos module

Module containing all Dtos and their Schemas for tasks in the Jobmanager API.

class qunicorn_core.api.api_models.job_dtos.JobCommandSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobExecutePythonFileDto(token: str | None = None, python_file_options: str | None = None, python_file_inputs: str | None = None)

Bases: object

python_file_inputs: str | None = None

python_file_options: str | None = None

token: str | None = None

class qunicorn_core.api.api_models.job_dtos.JobExecutionDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobFilterParamsSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobRequestDto(name: str, provider_name: str, device_name: str, shots: int, token: str, error_mitigation: ErrorMitigationMethod, cut_to_width: int | None, type: JobType, deployment_id: int)

Bases: object

JobDto that was sent from the user as a request

cut_to_width: int | None

deployment_id: int

device_name: str

error_mitigation: ErrorMitigationMethod

name: str

provider_name: str

shots: int

token: str

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobRequestDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobResponseDto(id: int, deployment_id: int | None, executed_by: str | None, executed_on: DeviceDto, progress: int, state: str, type: JobType, started_at: datetime, finished_at: datetime | None, name: str | None, results: list[ResultDto])

Bases: object

JobDto that is sent to the user as a response

deployment_id: int | None

executed_by: str | None

executed_on: DeviceDto

finished_at: datetime | None

id: int

name: str | None

progress: int

results: list[ResultDto]

started_at: datetime

state: str

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobResponseDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.QueuedJobsDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.SimpleJobDto(id: Optional[int], deployment_id: Optional[int], name: Optional[str], state: qunicorn_core.static.enums.job_state.JobState = <JobState.RUNNING: 'RUNNING'>)

Bases: object

deployment_id: int | None

id: int | None

name: str | None

state: JobState = 'RUNNING'

class qunicorn_core.api.api_models.job_dtos.SimpleJobDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.TokenSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>