ocrd_network.models.job module

class ocrd_network.models.job.StateEnum(value)

Bases: str, Enum

An enumeration.

cached = 'CACHED'

cancelled = 'CANCELLED'

queued = 'QUEUED'

running = 'RUNNING'

success = 'SUCCESS'

failed = 'FAILED'

class ocrd_network.models.job.PYJobInput(*, processor_name: str | None = None, path_to_mets: str | None = None, workspace_id: str | None = None, description: str | None = None, input_file_grps: List[str], output_file_grps: List[str] | None = None, page_id: str | None = None, parameters: dict = {}, result_queue_name: str | None = None, callback_url: str | None = None, agent_type: str | None = 'worker', job_id: str | None = None, depends_on: List[str] | None = None)

Bases: BaseModel

Wraps the parameters required to make a run-processor-request

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

processor_name: str | None

path_to_mets: str | None

workspace_id: str | None

description: str | None

input_file_grps: List[str]

output_file_grps: List[str] | None

page_id: str | None

parameters: dict

result_queue_name: str | None

callback_url: str | None

agent_type: str | None

job_id: str | None

depends_on: List[str] | None

class Config

Bases: object

schema_extra = {'example': {'description': 'The description of this execution', 'input_file_grps': ['INPUT_FILE_GROUP'], 'output_file_grps': ['OUTPUT_FILE_GROUP'], 'page_id': 'PAGE_ID', 'parameters': {}, 'path_to_mets': '/path/to/mets.xml'}}

class ocrd_network.models.job.PYJobOutput(*, job_id: str, processor_name: str, state: StateEnum, path_to_mets: str | None = None, workspace_id: str | None = None, input_file_grps: List[str], output_file_grps: List[str] | None = None, page_id: str | None = None, log_file_path: str | None = None)

Bases: BaseModel

Wraps output information for a job-response

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

job_id: str

processor_name: str

state: StateEnum

path_to_mets: str | None

workspace_id: str | None

input_file_grps: List[str]

output_file_grps: List[str] | None

page_id: str | None

log_file_path: str | None

class ocrd_network.models.job.DBProcessorJob(*args, _id: PydanticObjectId | None = None, revision_id: UUID | None = None, job_id: str, processor_name: str, path_to_mets: str | None = None, workspace_id: str | None = None, description: str | None = None, state: StateEnum, input_file_grps: List[str], output_file_grps: List[str] | None = None, page_id: str | None = None, parameters: dict | None = None, depends_on: List[str] | None = None, result_queue_name: str | None = None, callback_url: str | None = None, internal_callback_url: str | None = None, start_time: datetime | None = None, end_time: datetime | None = None, exec_time: str | None = None, log_file_path: str | None = None)

Bases: Document

Job representation in the database

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

job_id: str

processor_name: str

path_to_mets: str | None

workspace_id: str | None

description: str | None

state: StateEnum

input_file_grps: List[str]

output_file_grps: List[str] | None

page_id: str | None

parameters: dict | None

depends_on: List[str] | None

result_queue_name: str | None

callback_url: str | None

internal_callback_url: str | None

start_time: datetime | None

end_time: datetime | None

exec_time: str | None

log_file_path: str | None

class Settings

Bases: object

use_enum_values = True

to_job_output() → PYJobOutput

id: PydanticObjectId | None

revision_id: UUID | None

class ocrd_network.models.job.PYWorkflowJobOutput(*, job_id: str, page_id: str, page_wise: bool = False, processing_job_ids: Dict, path_to_mets: str | None = None, workspace_id: str | None = None, description: str | None = None)

Bases: BaseModel

Wraps output information for a workflow job-response

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

job_id: str

page_id: str

page_wise: bool

processing_job_ids: Dict

path_to_mets: str | None

workspace_id: str | None

description: str | None

class ocrd_network.models.job.DBWorkflowJob(*args, _id: PydanticObjectId | None = None, revision_id: UUID | None = None, job_id: str, page_id: str, page_wise: bool = False, processing_job_ids: Dict, path_to_mets: str | None = None, workspace_id: str | None = None, description: str | None = None, workflow_callback_url: str | None = None)

Bases: Document

Workflow job representation in the database

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

job_id: str

page_id: str

page_wise: bool

processing_job_ids: Dict

path_to_mets: str | None

workspace_id: str | None

description: str | None

workflow_callback_url: str | None

class Settings

Bases: object

use_enum_values = True

to_job_output() → PYWorkflowJobOutput

id: PydanticObjectId | None

revision_id: UUID | None