ComplianceClient

Submódulos

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

Contenido del módulo

Este módulo proporciona acceso a los endpoints de cumplimiento de X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con el cumplimiento.

class xdk.compliance.ComplianceClient

Cliente para operaciones de cumplimiento

Parámetros

path.client · Client

__init__

Parámetros

path.client · Client

create_jobs

Crear Compliance Job Crea un nuevo Compliance Job para el type de trabajo especificado. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateJobsResponse

Parámetros

body.body · CreateJobsRequest

get_jobs

Obtener trabajos de cumplimiento Recupera una lista de trabajos de cumplimiento filtrados por tipo de trabajo y, de forma opcional, por estado.

Parámetros

path.type · str

Tipo de Compliance Job que se va a listar.

path.status · str or None · predeterminado: "None"

Estado de Compliance Job que se va a listar.

path.compliance_job_fields · List or None · predeterminado: "None"

Una lista separada por comas de campos de ComplianceJob que se mostrarán.

Devuelve

GetJobsResponse - Datos de la respuesta

get_jobs_by_id

Obtener un trabajo de cumplimiento por id Recupera los detalles de un trabajo de cumplimiento específico por su id.

Parámetros

path.id · Any

El id del Compliance Job que se va a recuperar.

path.compliance_job_fields · List or None · predeterminado: "None"

Una lista, separada por comas, de campos de ComplianceJob que se van a mostrar.

Devuelve

GetJobsByIdResponse - Datos de respuesta