Skip to content

python

Directory actions

More options

Directory actions

More options

Latest commit

History

History

python

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.9.0
  • Package version: 0.0.33
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/geo-engine/openapi-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/geo-engine/openapi-client.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to https://geoengine.io/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="https://geoengine.io/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
dataset='dataset_example'# str | Dataset Nameauto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Add a tile to a gdal dataset.api_instance.add_dataset_tiles_handler(dataset, auto_create_dataset)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->add_dataset_tiles_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to https://geoengine.io/api

ClassMethodHTTP requestDescription
DatasetsApiadd_dataset_tiles_handlerPOST /dataset/{dataset}/tilesAdd a tile to a gdal dataset.
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files. The format of the files will be automatically detected when possible.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volume_file_layers_handlerGET /dataset/volumes/{volume_name}/files/{file_name}/layersList the layers of a file in a volume.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it. Tries to automatically detect the main file and layer name if not specified.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiadd_providerPOST /layerDb/providersAdd a new provider
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApidelete_providerDELETE /layerDb/providers/{provider}Delete an existing provider
LayersApiget_provider_definitionGET /layerDb/providers/{provider}Get an existing provider's definition
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_providersGET /layerDb/providersList all providers
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layerDELETE /layerDb/layers/{layer}Remove a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
LayersApiupdate_collectionPUT /layerDb/collections/{collection}Update a collection
LayersApiupdate_layerPUT /layerDb/layers/{layer}Update a layer
LayersApiupdate_provider_definitionPUT /layerDb/providers/{provider}Update an existing provider's definition
MLApiadd_ml_modelPOST /ml/modelsCreate a new ml model.
MLApiget_ml_modelGET /ml/models/{model_name}Get ml model by name.
MLApilist_ml_modelsGET /ml/modelsList ml models.
OGCWCSApiwcs_handlerGET /wcs/{workflow}OGC WCS endpoint
OGCWFSApiwfs_handlerGET /wfs/{workflow}OGC WFS endpoint
OGCWMSApiwms_handlerGET /wms/{workflow}OGC WMS endpoint
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project. This will create a new version.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect. This call must be preceded by a call to oidcInit and match the parameters of that call.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SessionApisession_project_handlerPOST /session/project/{project}Sets the active project of the session.
SessionApisession_view_handlerPOST /session/view
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApicomputation_quota_handlerGET /quota/computations/{computation}Retrieves the quota used by computation with the given computation id
UserApicomputations_quota_handlerGET /quota/computationsRetrieves the quota used by computations
UserApidata_usage_handlerGET /quota/dataUsageRetrieves the data usage
UserApidata_usage_summary_handlerGET /quota/dataUsage/summaryRetrieves the data usage summary
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /datasetFromWorkflow/{id}Create a task for creating a new dataset from the result of the workflow given by its `id` and the dataset parameters in the request body. Returns the id of the created task
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de