Módulo SiemplifyJob

clase SiemplifyJob.SiemplifyJob

Bases: Siemplify

Puntos finales: external/v1/sdk/GetFailedETLOperations

extract_job_param

extract_job_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

Obtiene un parámetro de configuración de la instancia de integración.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
param_name	{string}	Nombre del parámetro que se va a obtener.	N/A	N/A
default_value	{any}	El valor predeterminado del parámetro		(Opcional) El valor indicado se devolverá si no se ha definido el parámetro (si is_mandatory tiene el valor False). None de forma predeterminada
input_type	{obj}	El tipo de parámetro	N/A	(Opcional) El valor devuelto se convertirá al tipo de entrada seleccionado. {str} de forma predeterminada
is_mandatory	{boolean}	Define si el parámetro es obligatorio.	N/A	Opcional. Si se le asigna el valor True y no se ha rellenado el parámetro, se producirá una excepción. False de forma predeterminada
print_value	{boolean}	Define si se debe registrar el valor obtenido del parámetro.	N/A	(Opcional) False de forma predeterminada

Devoluciones

El valor del parámetro, que es una cadena de forma predeterminada, a menos que se especifique input_type.

Ejemplo

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
param_value= siemplify.extract_job_param(
                                       "Logs Folder",
                                       default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
                                       input_type=str,
                                       is_mandatory=False,
                                       print_value=False)

Comportamiento resultante

Se devolverá el valor del parámetro seleccionado, convertido al tipo seleccionado.

Valor de resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Obtiene la marca de tiempo y la guarda en el contexto del caso.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	Formato de fecha y hora	True para obtener el formato de fecha y hora, False para Unix	False de forma predeterminada (opcional)
timezone	El parámetro ya no se admite
new_timestamp	{int}	La marca de tiempo que se va a guardar	N/A	Tiempo de época de Unix de forma predeterminada (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtener la marca de tiempo guardada con save_timestamp.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	Si es True, devuelve la marca de tiempo como fecha y hora. De lo contrario, devuelve el valor en formato Unix.	Verdadero/Falso	False de forma predeterminada (opcional)
timezone	El parámetro ya no se admite

Devoluciones

Tiempo Unix o fecha y hora guardados.

get_configuration

get_configuration(provider, environment=None, integration_instance=None)

Obtiene la configuración de la integración.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
proveedor	{string}	Nombre de la integración	VirusTotal	El nombre del proveedor de integración distingue entre mayúsculas y minúsculas. Se producirá un error si la integración no está instalada o si la cadena no existe.
entorno	{string}	Configuración de un entorno específico o de todos	N/A	(Opcional) Si se proporcionan, las credenciales se obtendrán de la configuración del entorno correspondiente. Si no se indica ningún entorno, se usa el entorno del caso de forma predeterminada. Si no hay ninguna configuración para ese entorno específico, se devolverá la configuración predeterminada.
integration_instance	{string}	Identificador de la instancia de integración	N/A	N/A

Devoluciones

Detalles de configuración de {dict}

Ejemplo

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")

Comportamiento resultante

Se devolverá un diccionario con las credenciales guardadas para la integración de Google Security Operations Marketplace.

Valor de resultado

{
u'AgentIdentifier': None,
u'Api Key': u'c0c412#########################4f85b22e707',
u'Verify SSL': u'True',
u'RunRemotely': u'False'
}

get_failed_actions

get_failed_actions(number_of_hours)

Obtiene todas las tareas de ETL que han fallado en el número de horas especificado.

Devoluciones

{dict} tareas fallidas

{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Obtiene todas las tareas de ETL que han fallado en el número de horas especificado.

Devoluciones

{dict} tareas fallidas

{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Obtiene todos los conectores que han fallado entre las start_unix_time y las end_unix_time.

Devoluciones

{dict} conectores con errores

Valor de resultado

{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Obtiene todos los trabajos que han fallado en el número de horas especificado.

Devoluciones

{[dict]} tareas fallidas

Valor de resultado

[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]

get_job_context_property

get_job_context_property(identifier, property_key)

Obtiene un valor de contexto de trabajo mediante la clave proporcionada.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Clave de la propiedad que se va a obtener.	N/A	N/A

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Obtiene la propiedad de contexto de una tarea con ámbito mediante el identificador único de una tarea.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
property_key	{string}	Clave de la propiedad de contexto del trabajo	N/A	N/A

Devoluciones

Valor de una clave específica.

get_system_info

get_system_info(start_time_unixtime_ms)

property log_location

save_publisher_logs

save_publisher_logs(records)

Guarda los registros de los registros.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
registros	{list}	Registros que se guardarán	N/A	N/A

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Guardar marca de tiempo.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	N/A	True para el formato de fecha y hora y False para Unix	El valor predeterminado es False (opcional).
timezone	El parámetro ya no se admite
new_timestamp	{long}	Marca de tiempo que se guardará en el contexto	N/A	La marca de tiempo es, de forma predeterminada, la marca de tiempo de Unix de la llamada al método.

send_mail

send_mail(subject, message, recipients, attachment_file_name, attachment_content)

Enviar un correo (se permiten archivos adjuntos).

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
subject	{string}	Asunto del correo	N/A	N/A
mensaje	{string}	Mensaje de correo	N/A	N/A
attachment_file_name	{string}	Nombre del archivo adjunto	N/A	N/A
destinatarios	{[{string}]}	Lista de destinatarios	N/A	N/A

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

Define la propiedad de contexto de la tarea con ámbito mediante el identificador único de una tarea.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Clave de la propiedad de contexto del trabajo	N/A	N/A
property_value	{string}	Valor de la propiedad de contexto del trabajo	N/A	N/A

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

Define la propiedad de contexto de la tarea con ámbito mediante el identificador único de una tarea.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
property_key	{string}	Clave de la propiedad de contexto del trabajo	N/A	N/A
property_value	{string}	Valor de la propiedad de contexto del trabajo	N/A	N/A