Source code for ocrd_network.models.messages

from pydantic import BaseModel
from typing import Optional
from .job import JobState




[docs]
class PYResultMessage(BaseModel):
    """ Wraps the parameters required to make a result message request
    """
    job_id: str
    state: JobState = JobState.unset
    path_to_mets: Optional[str] = None
    workspace_id: Optional[str] = None



[docs]
    class Config:
        schema_extra = {
            "example": {
                "job_id": "d8e36726-ed28-5476-b83c-bc31d2eecf1f",
                "state": JobState.success,
                "path_to_mets": "/path/to/mets.xml",
                "workspace_id": "c7f25615-fc17-4365-a74d-ad20e1ddbd0e"
            }
        }