Source code for ocrd_network.constants

from enum import Enum

DOCKER_IMAGE_MONGO_DB = "mongo"
DOCKER_IMAGE_RABBIT_MQ = "rabbitmq:3.12-management"
# These feature flags are required by default to use the newer version
DOCKER_RABBIT_MQ_FEATURES = "quorum_queue,implicit_default_bindings,classic_mirrored_queue_version"

NETWORK_PROTOCOLS = ["http://", "https://"]
OCRD_ALL_TOOL_JSON = "ocrd-all-tool.json"
# Used as a placeholder to lock all pages when no page_id is specified
SERVER_ALL_PAGES_PLACEHOLDER = "all_pages"




[docs]
class AgentType(str, Enum):
    PROCESSING_WORKER = "worker"
    PROCESSOR_SERVER = "server"






[docs]
class DeployType(str, Enum):
    # Deployed by the Processing Server config file
    DOCKER = "docker"
    NATIVE = "native"
    # Deployed through a registration endpoint of the Processing Server
    # TODO: That endpoint is still not implemented
    EXTERNAL = "external"




# TODO: Make the states uppercase


[docs]
class JobState(str, Enum):
    # The processing job is cached inside the Processing Server requests cache
    cached = "CACHED"
    # The processing job was cancelled due to failed dependencies
    cancelled = "CANCELLED"
    # Processing job failed
    failed = "FAILED"
    # The processing job is queued inside the RabbitMQ
    queued = "QUEUED"
    # Processing job is currently running in a Worker or Processor Server
    running = "RUNNING"
    # Processing job finished successfully
    success = "SUCCESS"
    # Processing job has not been assigned yet
    unset = "UNSET"






[docs]
class NetworkLoggingDirs(str, Enum):
    METS_SERVERS = "mets_servers"
    PROCESSING_JOBS = "processing_jobs"
    PROCESSING_SERVERS = "processing_servers"
    PROCESSING_WORKERS = "processing_workers"
    PROCESSOR_SERVERS = "processor_servers"






[docs]
class ServerApiTags(str, Enum):
    ADMIN = "admin"
    DISCOVERY = "discovery"
    PROCESSING = "processing"
    TOOLS = "tools"
    WORKFLOW = "workflow"
    WORKSPACE = "workspace"