gpf_agent_rok4.rok4 module

class gpf_agent_rok4.rok4.Rok4(service_url: str, validate_ssl_certificate=True, retries=3, backoff_factor=0.9)

Bases : object

Cette classe permet de réaliser les actions de bases pour la configuration du serveur ROK4

Toutes les actions réalisées se basent sur l’API (OpenAPI) proposée par le serveur ROK4

__init__(service_url: str, validate_ssl_certificate=True, retries=3, backoff_factor=0.9)

Class ROK4. permettant d’intéragir avec l’API rest du serveur ROK4 »

Paramètres:

  • service_url (str) – url du serveur ROK4

  • validate_ssl_certificate (bool, optional) – validation des certificats ssl

  • retries – nombre d’essais autorisés

  • backoff_factor – facteur d’attente à appliquer entre les tentatives

delete_layer(layername: str) → Status

Permet de supprimer une couche sur le serveur ROK4

Paramètres:

layername (str) – nom de la couche

Renvoie:

Status de la suppression

Type renvoyé:

Status

get_layers() → list[str]

Récupère la liste des layers publiés sur le serveur ROK4

Renvoie:

liste des layers

Type renvoyé:

list[str]

get_version() → str | None
http_request(url, data=None, method='get', headers={}, files=None)

Définition d’une fonction générique pour envoyer des requetes

is_layer_exist(layername: str) → bool

Check si le layer en paramètre existe déjà sur le serveur ROK4

Paramètres:

layername (str) – nom du layer

Renvoie:

True si le layer existe, False sinon

Type renvoyé:

bool

publish_layer(layername: str, configuration: dict, check_exist: bool = True) → Status

Permet de publier une nouvelle couche sur le serveur ROK4

Paramètres:

  • layername (str) – nom de la couche

  • configuration (dict) – configuration de la couche

  • check_exist (bool, optional) – Doit on tester si le layer existe déjà.

Renvoie:

Status de la publication

Type renvoyé:

Status

setup_connection(retries=3, backoff_factor=0.9)

Définition des paramètres utilisés pour envoyer les requetes

Paramètres:

  • retries (int, optional) – nombre d’essais autorisés.

  • backoff_factor (float, optional) – facteur d’attente à appliquer entre les tentatives.

update_layer(layername: str, configuration: dict, check_exist: bool = True) → Status

Permet de mettre à jour une couche sur le serveur ROK4

Paramètres:

  • layername (str) – nom de la couche

  • configuration (dict) – configuration de la couche

  • check_exist (bool, optional) – Doit on tester si le layer existe déjà.

Renvoie:

Status de la mise à jour

Type renvoyé:

Status