Skip to content

Commit

Permalink
Minor load_stac_from_job documentation tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
soxofaan committed Sep 26, 2024
1 parent cfd9f1a commit bb4b448
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion openeo/rest/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -1441,7 +1441,10 @@ def load_stac_from_job(
properties: Optional[Dict[str, Union[str, PGNode, Callable]]] = None,
) -> DataCube:
"""
Wrapper for :py:meth:`load_stac` that loads the result of a previous job using the STAC collection of its results.
Convenience function to directly load the results of a finished openEO job
(as a STAC collection) with :py:meth:`load_stac` in a new openEO process graph.
When available, the "canonical" link (signed URL) of the job results will be used.
:param job: a :py:class:`~openeo.rest.job.BatchJob` or job id pointing to a finished job.
Note that the :py:class:`~openeo.rest.job.BatchJob` approach allows to point
Expand All @@ -1452,6 +1455,7 @@ def load_stac_from_job(
.. versionadded:: 0.30.0
"""
# TODO #634 add option to require or avoid the canonical link
if isinstance(job, str):
job = BatchJob(job_id=job, connection=self)
elif not isinstance(job, BatchJob):
Expand Down

0 comments on commit bb4b448

Please sign in to comment.