weaver.processes.ogc_api_process
================================

.. py:module:: weaver.processes.ogc_api_process




Module Contents
---------------

.. py:class:: OGCAPIRemoteProcess(step_payload: weaver.typedefs.JSON, process: str, request: Optional[weaver.wps.service.WorkerRequest], update_status: weaver.typedefs.UpdateStatusPartialFunction)



   Common interface for :term:`WPS` :term:`Process` to be used for dispatching :term:`CWL` jobs.

   Multiple convenience methods are provided.
   Processes inheriting from this base should implement required abstract methods and override operations as needed.

   .. note::
       For expected operations details and their execution order, please refer to :ref:`proc_workflow_ops`.

   .. seealso::
       :meth:`execute` for complete details of the operations and ordering.


   .. py:attribute:: process_type
      :value: 'OGC API'



   .. py:attribute:: url


   .. py:method:: prepare(workflow_inputs: weaver.typedefs.JobInputs, expected_outputs: weaver.typedefs.CWL_ExpectedOutputs) -> None

      Implementation dependent operations to prepare the :term:`Process` for :term:`Job` execution.

      This is an optional step that can be omitted entirely if not needed.
      This step should be considered for the creation of a reusable client or object handler that does not need to be
      recreated on any subsequent steps, such as for :meth:`dispatch` and :meth:`monitor` calls.



   .. py:method:: format_inputs(job_inputs: weaver.typedefs.JobInputs) -> weaver.typedefs.ExecutionInputsMap

      Implementation dependent operations to configure input values for :term:`Job` execution.

      This is an optional step that will simply pass down the inputs as is if no formatting is required.
      Otherwise, the implementing :term:`Process` can override the step to reorganize workflow step inputs into the
      necessary format required for their :meth:`dispatch` call.



   .. py:method:: format_outputs(job_outputs: weaver.typedefs.JobOutputs) -> Optional[weaver.typedefs.ExecutionOutputsMap]

      Implementation dependent operations to configure expected outputs for :term:`Job` execution.

      This is an optional step that will simply pass down the outputs as is if no formatting is required.
      Otherwise, the implementing :term:`Process` can override the step to reorganize workflow step outputs into the
      necessary format required for their :meth:`dispatch` call.