Skip to content
PineXQ Logo PineXQ Documentation

HCO class reference

The following listing contains the class specifications for all HCO implementations of API specific entities in pinexq.client.job_management. These are low-level API objects for which ProcessingStep, Job and WorkData provide a convenience interface, and contain information about the entities on the server. In particular, search queries return these HCOs; we provide a class function from_hco to construct the convenience object from the HCO, when available.

Member of a class can be either of the aforementioned basic types:

  • A Link can be used to navigate to the corresponding next entity.
  • Actions can be executed and might require parameters.
  • Every other annotation means that this is a property of this class and contains entity specific data.

Annotation with * | None mean that this member is optional and can be None, if the entity in its current state can not offer this action, link or property: for example, WorkDataHco.allow_deletion_action is None if the WorkData is already deletable. Best practice is to check before executing:

if "TEST" in workdata_hco.tags:
    if workdata_hco.allow_deletion_action:
        workdata_hco.allow_deletion_action.execute()
        workdata_hco = workdata_hco.self_link.navigate() #refresh HCO
    workdata_hco.delete_action.execute()

EntryPoint

Section titled “EntryPoint”
class EntryPointHco(Hco):
    self_link:                  Link
    job_root_link:              Link
    work_data_root_link:        Link
    processing_step_root_link:  Link
    info_link:                  Link

Info

Section titled “Info”
class InfoHco(Hco):
    api_version:   str
    build_version: str


    self_link:     Link

JobsRoot

Section titled “JobsRoot”
class JobsRootHco(Hco):
    create_job_action:      Action | None
    job_query_action:       Action | None
    create_subjob_action:   Action | None


    self_link:              Link

Job

Section titled “Job”
class JobHco(Hco):
    name:               str
    state:              JobStates
    marked_as_deleted:  bool
    creation_date:      datetime
    error_description:  str
    processing:         ProcessingView
    result:             str


    self_link:                      Link
    parent_link:                    Link | None
    selected_processing_step_link:  Link | None


    rename_action:                  Action | None
    select_processing_action:       Action | None
    delete_action:                  Action | None
    configure_processing_action:    Action | None
    start_processing_action:        Action | None

JobQueryResult

Section titled “JobQueryResult”
class JobQueryResultHco(Hco):
    self_link:      Link
    all_link:       Link | None
    first_link:     Link | None
    last_link:      Link | None
    next_link:      Link | None
    previous_link:  Link | None


    total_entities:         int
    current_entities_count: int
    jobs:                   List[JobHco]

ProcessingStepsRoot

Section titled “ProcessingStepsRoot”
class ProcessingStepsRootHco(Hco):
    query_action:        Action | None
    register_new_action: Action | None


    self_link:  Link
    all_link:   Link | None

ProcessingStep

Section titled “ProcessingStep”
class ProcessingStepHco(Hco):
    title:                           str
    version:                         str | None
    function_name:                   str | None
    short_description:               str | None
    long_description:                str | None
    has_parameters:                  bool | None
    is_public:                       bool | None
    is_configured:                   bool | None
    created_at:                      datetime | None
    last_modified:                   datetime | None
    parameter_schema:                str | None
    default_parameters:              str | None
    return_schema:                   str | None
    error_schema:                    str | None
    input_data_slot_specification:   List[DataSpecificationHto] | None
    output_data_slot_specification:  List[DataSpecificationHto] | None


    self_link:          Link
    download_link:      DownloadLink

ProcessingStepQueryResult

Section titled “ProcessingStepQueryResult”
class ProcessingStepQueryResultHco(Hco):
    total_entities:         int
    current_entities_count: int
    processing_steps:       List[ProcessingStepHco]


    self_link:      Link
    all_link:       Link | None
    first_link:     Link | None
    last_link:      Link | None
    next_link:      Link | None
    previous_link:  Link | None

WorkDataRoot

Section titled “WorkDataRoot”
class WorkDataRootHco(Hco):
    query_action:    Action | None
    upload_action:   Action | None


    self_link:       Link
    all_link:        Link | None

WorkData

Section titled “WorkData”
class WorkDataHco(Hco):
    name:           str | None
    created_on:     datetime | None
    size_in_bytes:  int | None
    tags:           list[str] | None
    media_type:     str | None
    kind:           WorkDataKind | None
    comments:       str | None


    delete_action:       Action | None
    rename_action:       Action | None
    edit_comment_action: Action | None
    edit_tags_action:    Action | None


    self_link:           Link
    download_link:       DownloadLink

WorkDataQueryResult

Section titled “WorkDataQueryResult”
class WorkDataQueryResultHco(Hco):
    workdata_query_action: WorkDataQueryResultEntity


    total_entities:         int
    current_entities_count: int
    workdatas:              List[WorkDataHco]


    self_link:      Link
    all_link:       Link | None
    first_link:     Link | None
    last_link:      Link | None
    next_link:      Link | None
    previous_link:  Link | None