Módulo SiemplifyJob

clase SiemplifyJob.SiemplifyJob

Bases: Siemplify

Endpoints: 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	Valores posibles	Comentarios
param_name	{string}	Nombre del parámetro que se recuperará	N/A	N/A
default_value	{any}	El valor predeterminado del parámetro		(Opcional) Se devolverá el valor proporcionado si no se configuró el parámetro (si is_mandatory se establece en False). None de forma predeterminada
input_type	{obj}	Tipo del 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 establece como verdadero y no se completó el parámetro, se generará una excepción. False de forma predeterminada
print_value	{boolean}	Define si se debe generar el valor recuperado del parámetro en los registros.	N/A	(Opcional) False de forma predeterminada

Devoluciones

Es el valor del parámetro, 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 del resultado

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

Valor del resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Recupera la marca de tiempo y guárdala en el contexto del caso.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	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)
Zona horaria	El parámetro ya no se admite
new_timestamp	{int}	Es la marca de tiempo que se guardará.	N/A	Tiempo de época Unix de forma predeterminada (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtén la marca de tiempo guardada con save_timestamp.

Parámetros

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

Devoluciones

Fecha y hora o hora Unix guardadas.

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	Valores posibles	Comentarios
proveedor	{string}	Nombre de la integración	VirusTotal	El nombre del proveedor de integración distingue mayúsculas de minúsculas. Se arrojará un error si la integración no está instalada o si la cadena no existe.
entorno	{string}	Configuración para un entorno específico o "todos"	N/A	(Opcional) Si se proporciona, las credenciales se recuperará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 una 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 {dict}

Ejemplo

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

Comportamiento del resultado

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

Valor del 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)

Obtén todos los trabajos de ETL que fallaron en la cantidad de horas especificada.

Devoluciones

{dict} trabajos con errores

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

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Obtén todos los trabajos de ETL que fallaron en la cantidad de horas especificada.

Devoluciones

{dict} trabajos con errores

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

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Obtén todos los conectores que tuvieron fallas entre start_unix_time y end_unix_time.

Devoluciones

Conectores con errores de {dict}

Valor del resultado

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

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Obtén todos los trabajos que fallaron en la cantidad de horas especificada.

Devoluciones

{[dict]} trabajos con errores

Valor del 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 con la clave determinada.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Es la clave de la propiedad que se recuperará.	N/A	N/A

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Obtén la propiedad del contexto del trabajo con alcance usando el identificador único de un trabajo.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
property_key	{string}	Es la clave de la propiedad de contexto del trabajo.	N/A	N/A

Devoluciones

Es el 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 del editor.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
records	{list}	Registros para guardar	N/A	N/A

save_timestamp

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

Es la marca de tiempo de guardado.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
datetime_format	{boolean}	N/A	True para el formato de fecha y hora, False para Unix	El valor predeterminado es False (opcional).
Zona horaria	El parámetro ya no se admite
new_timestamp	{long}	Marca de tiempo para guardar en el contexto	N/A	La marca de tiempo se establece de forma predeterminada en 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 electrónico (se permiten archivos adjuntos)

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
asunto	{string}	Asunto del correo electrónico	N/A	N/A
mensaje	{string}	Mensaje de correo electrónico	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)

Establece la propiedad de contexto del trabajo con alcance usando el identificador único de un trabajo.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Es la 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)

Establece la propiedad de contexto del trabajo con alcance usando el identificador único de un trabajo.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
property_key	{string}	Es la 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