Skip to content

gavicore.service API Reference

gavicore.service.Service

Bases: ABC

get_capabilities abstractmethod async 

get_capabilities(*args, **kwargs) -> Capabilities
The landing page provides links to the
  • The OpenAPI-definition (no fixed path),
  • The Conformance statements (path /conformance),
  • The processes metadata (path /processes),
  • The endpoint for job monitoring (path /jobs).

For more information, see Section 7.2.

get_conformance abstractmethod async 

get_conformance(*args, **kwargs) -> ConformanceDeclaration

A list of all conformance classes, specified in a standard, that the server conforms to.

Conformance class URI
Core http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
OGC Process Description http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description
JSON http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json
HTML http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html
OpenAPI Specification 3.0 http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30
Job list http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list
Callback http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback
Dismiss http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss

For more information, see Section 7.4.

get_processes abstractmethod async 

get_processes(*args, **kwargs) -> ProcessList

The list of processes contains a summary of each process the OGC API - Processes offers, including the link to a more detailed description of the process.

For more information, see Section 7.9.

get_process abstractmethod async 

get_process(process_id: str, *args, **kwargs) -> ProcessDescription

The process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following recommendation:

Implementations SHOULD consider supporting the OGC process description.

For more information, see Section 7.10.

execute_process abstractmethod async 

execute_process(
    process_id: str, process_request: ProcessRequest, *args, **kwargs
) -> JobInfo

Create a new job.

For more information, see Section 7.11.

get_jobs abstractmethod async 

get_jobs(*args, **kwargs) -> JobList

Lists available jobs.

For more information, see Section 11.

get_job abstractmethod async 

get_job(job_id: str, *args, **kwargs) -> JobInfo

Shows the status of a job.

For more information, see Section 7.12.

dismiss_job abstractmethod async 

dismiss_job(job_id: str, *args, **kwargs) -> JobInfo

Cancel a job execution and remove it from the jobs list.

For more information, see Section 13.

get_job_results abstractmethod async 

get_job_results(job_id: str, *args, **kwargs) -> JobResults

Lists available results of a job. In case of a failure, lists errors instead.

For more information, see Section 7.13.