weaver.wps_restapi.jobs.jobs
¶
Module Contents¶
-
weaver.wps_restapi.jobs.jobs.
get_local_status_location
(url_status_location, container, must_exist=True) → Optional[AnyStr][source]¶ Attempts to retrieve the local file path corresponding to the WPS status location as URL.
Parameters: - url_status_location – URL reference pointing to some WPS status location XML.
- container – any settings container to map configured local paths.
- must_exist – return only existing path if enabled, otherwise return the parsed value without validation.
Returns: found local file path if it exists,
None
otherwise.
-
weaver.wps_restapi.jobs.jobs.
check_status
(url=None, response=None, sleep_secs=2, verify=True, settings=None) → WPSExecution[source]¶ Run
owslib.wps.WPSExecution.checkStatus()
with additional exception handling.Parameters: - url – job URL where to look for job status.
- response – WPS response document of job status.
- sleep_secs – number of seconds to sleep before returning control to the caller.
- verify – Flag to enable SSL verification.
- settings – Application settings to retrieve any additional request parameters as applicable.
Returns: OWSLib.wps.WPSExecution object.
-
weaver.wps_restapi.jobs.jobs.
get_job
(request) → Job[source]¶ Obtain a job from request parameters.
Returns: Job information if found. Raises: HTTPNotFound with JSON body details on missing/non-matching job, process, provider IDs.
-
weaver.wps_restapi.jobs.jobs.
validate_service_process
(request) → Tuple[Union[None, AnyStr], Union[None, AnyStr]][source]¶ Verifies that service or process specified by path or query will raise the appropriate error if applicable.
-
weaver.wps_restapi.jobs.jobs.
get_queried_jobs
(request)[source]¶ Retrieve the list of jobs which can be filtered, sorted, paged and categorized using query parameters.
-
weaver.wps_restapi.jobs.jobs.
cancel_job
(request)[source]¶ Dismiss a job.
Note: Will only stop tracking this particular process (WPS 1.0 doesn’t allow to stop a process)