Issue #604/#644 add process_id to docs

Open-EO · Oct 14, 2024 · a92e47f · a92e47f
1 parent d29d3ee
commit a92e47f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/cookbook/job_manager.rst b/docs/cookbook/job_manager.rst
@@ -14,3 +14,5 @@ Multi Backend Job Manager
 .. autoclass:: openeo.extra.job_management.CsvJobDatabase
 
 .. autoclass:: openeo.extra.job_management.ParquetJobDatabase
+
+.. autoclass:: openeo.extra.job_management.UDPJobFactory
diff --git a/openeo/extra/job_management.py b/openeo/extra/job_management.py
@@ -969,6 +969,15 @@ class UDPJobFactory:
         job_manager = MultiBackendJobManager(...)
         job_manager.run_jobs(job_db=job_db, start_job=job_starter)
 
+    :param process_id: (optional) openEO process identifier.
+        Can be omitted when working with a remote process definition
+        given as URL in the ``namespace`` parameter.
+    :param namespace: (optional) openEO process namespace.
+        Typically used to provide a URL to a remote process definition.
+    :param parameter_defaults: Default values for process parameters,
+        to be used when not provided from the dataframe row in
+        :py:meth:`MultiBackendJobManager.run_jobs`.
+
     .. versionadded:: 0.33.0
     """