Module SiemplifyJob

class SiemplifyJob.SiemplifyJob

Bases : Siemplify

Points de terminaison : 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)

Obtenez un paramètre de configuration à partir de l'instance d'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
param_name	{string}	Nom du paramètre à récupérer	N/A	N/A
default_value	{any}	Valeur par défaut du paramètre		(Facultatif) La valeur indiquée sera renvoyée si le paramètre n'a pas été défini (si is_mandatory est défini sur False). None par défaut
input_type	{obj}	Type du paramètre	N/A	(Facultatif) La valeur renvoyée sera convertie au type d'entrée sélectionné. {str} par défaut
is_mandatory	{boolean}	Définit si le paramètre est obligatoire.	N/A	(Facultatif) Si la valeur est définie sur "True" et que le paramètre n'a pas été renseigné, une exception sera générée. False par défaut
print_value	{boolean}	Définit s'il faut afficher la valeur récupérée du paramètre dans les journaux.	N/A	(Facultatif) False par défaut

Renvoie

Valeur du paramètre, chaîne par défaut, sauf si input_type est spécifié.

Exemple

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)

Comportement des résultats

La valeur du paramètre sélectionné sera renvoyée et convertie au type sélectionné.

Result value

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Récupérez le code temporel et enregistrez-le dans le contexte de la demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	Format de date/heure	True pour obtenir le format datetime, False pour Unix	False par défaut (facultatif)
timezone	Paramètre plus accepté
new_timestamp	{int}	Code temporel à enregistrer	N/A	Heure de l'epoch Unix par défaut (facultatif)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtenez le code temporel enregistré avec save_timestamp.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	Si la valeur est True, renvoie l'horodatage sous forme de date et heure. Sinon, renvoie la valeur au format Unix	Vrai/Faux	False par défaut (facultatif)
timezone	Paramètre plus accepté

Renvoie

Date et heure Unix enregistrées.

get_configuration

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

Obtenez la configuration de l'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
fournisseur	{string}	Nom de l'intégration	VirusTotal	Le nom du fournisseur d'intégration est sensible à la casse. Une erreur sera générée si l'intégration n'est pas installée ou si la chaîne n'existe pas.
de test	{string}	Configuration pour un environnement spécifique ou pour "tous"	N/A	(Facultatif) Si des identifiants sont fournis, ils seront récupérés à partir de la configuration d'environnement correspondante. Si aucun environnement n'est indiqué,l'environnement de cas est utilisé par défaut. Si aucune configuration n'est définie pour cet environnement spécifique, la configuration par défaut sera renvoyée.
integration_instance	{string}	Identifiant de l'instance d'intégration	N/A	N/A

Renvoie

Détails de la configuration {dict}

Exemple

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

Comportement des résultats

Un dictionnaire contenant les identifiants enregistrés pour l'intégration depuis Google Security Operations Marketplace sera renvoyé.

Result value

{
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)

Obtenez tous les jobs ETL ayant échoué au cours du nombre d'heures spécifié.

Renvoie

Échec de {dict} jobs

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

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Obtenez tous les jobs ETL ayant échoué au cours du nombre d'heures spécifié.

Renvoie

Échec de {dict} jobs

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

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Obtenez tous les connecteurs qui ont échoué entre start_unix_time et end_unix_time.

Renvoie

{dict} connecteurs en échec

Result value

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

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Obtenez tous les jobs qui ont échoué au cours du nombre d'heures spécifié.

Renvoie

{[dict]} jobs ayant échoué

Result value

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

get_job_context_property

get_job_context_property(identifier, property_key)

Obtenez une valeur de contexte de job par la clé donnée.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
identifiant	{string}	Identifiant de contexte	N/A	N/A
property_key	{string}	Clé de la propriété à extraire	N/A	N/A

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Obtenez la propriété du contexte de job à portée limitée à l'aide de l'identifiant unique d'un job.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
property_key	{string}	Clé de la propriété de contexte du job	N/A	N/A

Renvoie

Valeur d'une clé spécifique.

get_system_info

get_system_info(start_time_unixtime_ms)

property log_location

save_publisher_logs

save_publisher_logs(records)

Enregistrez les journaux d'éditeur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
records	{list}	Enregistrements à sauvegarder	N/A	N/A

save_timestamp

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

Enregistrez l'horodatage.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
datetime_format	{boolean}	N/A	True pour le format datetime, False pour le format Unix	La valeur par défaut est False (facultatif).
timezone	Paramètre plus accepté
new_timestamp	{long}	Code temporel à enregistrer dans le contexte	N/A	L'horodatage est défini par défaut sur le code temporel Unix de l'appel de la méthode.

send_mail

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

Envoyez un e-mail (pièces jointes autorisées).

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
subject	{string}	Objet de l'e-mail	N/A	N/A
message	{string}	Corps de l'e-mail	N/A	N/A
attachment_file_name	{string}	Nom de fichier de la pièce jointe	N/A	N/A
destinataires	{[{string}]}	Liste des destinataires	N/A	N/A

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

Définissez une propriété de contexte de job à portée limitée à l'aide de l'identifiant unique d'un job.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
identifiant	{string}	Identifiant de contexte	N/A	N/A
property_key	{string}	Clé de la propriété de contexte du job	N/A	N/A
property_value	{string}	Valeur de la propriété de contexte du job	N/A	N/A

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

Définissez une propriété de contexte de job à portée limitée à l'aide de l'identifiant unique d'un job.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
property_key	{string}	Clé de la propriété de contexte du job	N/A	N/A
property_value	{string}	Valeur de la propriété de contexte du job	N/A	N/A