Skip to content

Latest commit

 

History

History
455 lines (414 loc) · 30 KB

README.md

File metadata and controls

455 lines (414 loc) · 30 KB

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.31
  • Generator version: 7.18.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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import geoengine_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:

import geoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import geoengine_openapi_client
from geoengine_openapi_client.rest import ApiException
from pprint import pprint

# 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_token
configuration = geoengine_openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with geoengine_openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = geoengine_openapi_client.DatasetsApi(api_client)
    dataset = 'dataset_example' # str | Dataset Name
    auto_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)
    except ApiException as e:
        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

Class Method HTTP request Description
DatasetsApi add_dataset_tiles_handler POST /dataset/{dataset}/tiles Add a tile to a gdal dataset.
DatasetsApi auto_create_dataset_handler POST /dataset/auto Creates a new dataset using previously uploaded files. The format of the files will be automatically detected when possible.
DatasetsApi create_dataset_handler POST /dataset Creates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApi delete_dataset_handler DELETE /dataset/{dataset} Delete a dataset
DatasetsApi get_dataset_handler GET /dataset/{dataset} Retrieves details about a dataset using the internal name.
DatasetsApi get_loading_info_handler GET /dataset/{dataset}/loadingInfo Retrieves the loading information of a dataset
DatasetsApi list_datasets_handler GET /datasets Lists available datasets.
DatasetsApi list_volume_file_layers_handler GET /dataset/volumes/{volume_name}/files/{file_name}/layers List the layers of a file in a volume.
DatasetsApi list_volumes_handler GET /dataset/volumes Lists available volumes.
DatasetsApi suggest_meta_data_handler POST /dataset/suggest Inspects 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.
DatasetsApi update_dataset_handler POST /dataset/{dataset} Update details about a dataset using the internal name.
DatasetsApi update_dataset_provenance_handler PUT /dataset/{dataset}/provenance
DatasetsApi update_dataset_symbology_handler PUT /dataset/{dataset}/symbology Updates the dataset's symbology
DatasetsApi update_loading_info_handler PUT /dataset/{dataset}/loadingInfo Updates the dataset's loading info
GeneralApi available_handler GET /available Server availablity check.
GeneralApi server_info_handler GET /info Shows information about the server software version.
LayersApi add_collection POST /layerDb/collections/{collection}/collections Add a new collection to an existing collection
LayersApi add_existing_collection_to_collection POST /layerDb/collections/{parent}/collections/{collection} Add an existing collection to a collection
LayersApi add_existing_layer_to_collection POST /layerDb/collections/{collection}/layers/{layer} Add an existing layer to a collection
LayersApi add_layer POST /layerDb/collections/{collection}/layers Add a new layer to a collection
LayersApi add_provider POST /layerDb/providers Add a new provider
LayersApi autocomplete_handler GET /layers/collections/search/autocomplete/{provider}/{collection} Autocompletes the search on the contents of the collection of the given provider
LayersApi delete_provider DELETE /layerDb/providers/{provider} Delete an existing provider
LayersApi get_provider_definition GET /layerDb/providers/{provider} Get an existing provider's definition
LayersApi layer_handler GET /layers/{provider}/{layer} Retrieves the layer of the given provider
LayersApi layer_to_dataset POST /layers/{provider}/{layer}/dataset Persist a raster layer from a provider as a dataset.
LayersApi layer_to_workflow_id_handler POST /layers/{provider}/{layer}/workflowId Registers a layer from a provider as a workflow and returns the workflow id
LayersApi list_collection_handler GET /layers/collections/{provider}/{collection} List the contents of the collection of the given provider
LayersApi list_providers GET /layerDb/providers List all providers
LayersApi list_root_collections_handler GET /layers/collections List all layer collections
LayersApi provider_capabilities_handler GET /layers/{provider}/capabilities
LayersApi remove_collection DELETE /layerDb/collections/{collection} Remove a collection
LayersApi remove_collection_from_collection DELETE /layerDb/collections/{parent}/collections/{collection} Delete a collection from a collection
LayersApi remove_layer DELETE /layerDb/layers/{layer} Remove a collection
LayersApi remove_layer_from_collection DELETE /layerDb/collections/{collection}/layers/{layer} Remove a layer from a collection
LayersApi search_handler GET /layers/collections/search/{provider}/{collection} Searches the contents of the collection of the given provider
LayersApi update_collection PUT /layerDb/collections/{collection} Update a collection
LayersApi update_layer PUT /layerDb/layers/{layer} Update a layer
LayersApi update_provider_definition PUT /layerDb/providers/{provider} Update an existing provider's definition
MLApi add_ml_model POST /ml/models Create a new ml model.
MLApi get_ml_model GET /ml/models/{model_name} Get ml model by name.
MLApi list_ml_models GET /ml/models List ml models.
OGCWCSApi wcs_handler GET /wcs/{workflow} OGC WCS endpoint
OGCWFSApi wfs_handler GET /wfs/{workflow} OGC WFS endpoint
OGCWMSApi wms_handler GET /wms/{workflow} OGC WMS endpoint
PermissionsApi add_permission_handler PUT /permissions Adds a new permission.
PermissionsApi get_resource_permissions_handler GET /permissions/resources/{resource_type}/{resource_id} Lists permission for a given resource.
PermissionsApi remove_permission_handler DELETE /permissions Removes an existing permission.
PlotsApi get_plot_handler GET /plot/{id} Generates a plot.
ProjectsApi create_project_handler POST /project Create a new project for the user.
ProjectsApi delete_project_handler DELETE /project/{project} Deletes a project.
ProjectsApi list_projects_handler GET /projects List all projects accessible to the user that match the selected criteria.
ProjectsApi load_project_latest_handler GET /project/{project} Retrieves details about the latest version of a project.
ProjectsApi load_project_version_handler GET /project/{project}/{version} Retrieves details about the given version of a project.
ProjectsApi project_versions_handler GET /project/{project}/versions Lists all available versions of a project.
ProjectsApi update_project_handler PATCH /project/{project} Updates a project. This will create a new version.
SessionApi anonymous_handler POST /anonymous Creates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApi login_handler POST /login Creates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApi logout_handler POST /logout Ends a session.
SessionApi oidc_init POST /oidcInit Initializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApi oidc_login POST /oidcLogin Creates 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.
SessionApi register_user_handler POST /user Registers a user.
SessionApi session_handler GET /session Retrieves details about the current session.
SessionApi session_project_handler POST /session/project/{project} Sets the active project of the session.
SessionApi session_view_handler POST /session/view
SpatialReferencesApi get_spatial_reference_specification_handler GET /spatialReferenceSpecification/{srsString}
TasksApi abort_handler DELETE /tasks/{id} Abort a running task.
TasksApi list_handler GET /tasks/list Retrieve the status of all tasks.
TasksApi status_handler GET /tasks/{id}/status Retrieve the status of a task.
UploadsApi list_upload_file_layers_handler GET /uploads/{upload_id}/files/{file_name}/layers List the layers of on uploaded file.
UploadsApi list_upload_files_handler GET /uploads/{upload_id}/files List the files of on upload.
UploadsApi upload_handler POST /upload Uploads files.
UserApi add_role_handler PUT /roles Add a new role. Requires admin privilige.
UserApi assign_role_handler POST /users/{user}/roles/{role} Assign a role to a user. Requires admin privilige.
UserApi computation_quota_handler GET /quota/computations/{computation} Retrieves the quota used by computation with the given computation id
UserApi computations_quota_handler GET /quota/computations Retrieves the quota used by computations
UserApi data_usage_handler GET /quota/dataUsage Retrieves the data usage
UserApi data_usage_summary_handler GET /quota/dataUsage/summary Retrieves the data usage summary
UserApi get_role_by_name_handler GET /roles/byName/{name} Get role by name
UserApi get_role_descriptions GET /user/roles/descriptions Query roles for the current user.
UserApi get_user_quota_handler GET /quotas/{user} Retrieves the available and used quota of a specific user.
UserApi quota_handler GET /quota Retrieves the available and used quota of the current user.
UserApi remove_role_handler DELETE /roles/{role} Remove a role. Requires admin privilige.
UserApi revoke_role_handler DELETE /users/{user}/roles/{role} Revoke a role from a user. Requires admin privilige.
UserApi update_user_quota_handler POST /quotas/{user} Update the available quota of a specific user.
WorkflowsApi dataset_from_workflow_handler POST /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
WorkflowsApi get_workflow_all_metadata_zip_handler GET /workflow/{id}/allMetadata/zip Gets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApi get_workflow_metadata_handler GET /workflow/{id}/metadata Gets the metadata of a workflow
WorkflowsApi get_workflow_provenance_handler GET /workflow/{id}/provenance Gets the provenance of all datasets used in a workflow.
WorkflowsApi load_workflow_handler GET /workflow/{id} Retrieves an existing Workflow.
WorkflowsApi raster_stream_websocket GET /workflow/{id}/rasterStream Query a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApi register_workflow_handler POST /workflow Registers 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