ComplianceClient

​

Sous-modules

• Module xdk.compliance.client
  • ComplianceClient
    • ComplianceClient.__init__()
    • ComplianceClient.create_jobs()
    • ComplianceClient.get_jobs()
    • ComplianceClient.get_jobs_by_id()
• Module xdk.compliance.models
  • CreateJobsRequest
    • CreateJobsRequest.model_config
  • CreateJobsResponse
    • CreateJobsResponse.model_config
  • GetJobsByIdResponse
    • GetJobsByIdResponse.model_config
  • GetJobsResponse
    • GetJobsResponse.model_config

​

Contenu du module

Ce module donne accès aux endpoints de conformité de X API et constitue le point d’entrée principal pour toutes les fonctionnalités de conformité.

​

class xdk.compliance.ComplianceClient

Client pour les opérations de conformité

​

Paramètres

path.client · Client

​

__init__

​

Paramètres

path.client · Client

​

create_jobs

Créer un job de conformité Crée un nouveau job de conformité pour le type de job spécifié. body: Corps de la requête :returns: Données de la réponse :rtype: CreateJobsResponse

​

Paramètres

body.body · CreateJobsRequest

​

get_jobs

Obtenir les jobs de conformité Récupère la liste des jobs de conformité filtrés en fonction du type de job et, éventuellement, de leur statut.

​

Paramètres

path.type · str

Type de Compliance Job à lister.

path.status · str or None · défaut: "None"

Statut du Compliance Job à lister.

path.compliance_job_fields · List or None · défaut: "None"

Une liste de champs ComplianceJob, séparés par des virgules, à afficher.

​

Renvoie

GetJobsResponse - Données de réponse

​

get_jobs_by_id

Récupérer un Compliance Job par ID Récupère les détails d’un Compliance Job spécifique à l’aide de son ID.

​

Paramètres

path.id · Any

L’identifiant du Compliance Job à récupérer.

path.compliance_job_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, des champs ComplianceJob à afficher.

​

Renvoie

GetJobsByIdResponse - Données de la réponse