Module smp_time

TIPCommon.smp_time.change_timezone

TIPCommon.smp_time.change_timezone(dtime: datetime, current_tz: str, new_tz: str)→ datetime

Modifie le fuseau horaire d'un objet datetime.datetime.

Paramètres

Paramètres
dtime	datetime.datetime Objet datetime dont le fuseau horaire est modifié.
current_tz	str Fuseau horaire actuel.
new_tz	str Fuseau horaire à définir.

Renvoie

Nouvel objet datetime avec un nouveau fuseau horaire.

Type renvoyé

datetime.datetime

Génère

ValueError : lorsqu'un des fuseaux horaires n'est pas valide.

TIPCommon.smp_time.convert_string_to_timestamp

TIPCommon.smp_time.convert_string_to_timestamp(datetime_string: str)→ int

Convertit une chaîne datetime en code temporel.

Paramètres

Paramètres
datetime_string	str Chaîne de date et heure.

Renvoie

Horodatage.

Type renvoyé

int

TIPCommon.smp_time.datetime_to_rfc3339

TIPCommon.smp_time.datetime_to_rfc3339(datetime_obj: datetime)→ str

Convertit un objet datetime en représentation RFC 3999.

Paramètres

Paramètres
datetime_obj	datetime.datetime Objet datetime à convertir.

Renvoie

Représentation RFC 3339 de la date et de l'heure.

Type renvoyé

str

TIPCommon.smp_time.get_last_success_time

TIPCommon.smp_time.get_last_success_time(siemplify, offset_with_metric, time_format=2, print_value=True, microtime=False)

Obtient la dernière heure ou date de réussite.

Paramètres
siemplify	obj Instance de la classe SiemplifyConnectorExecution du SDK.
offset_with_metric	dict Métrique et valeur. Exemple : {'hours': 1}
time_format	int Format de l'heure de sortie. Exemple : DATETIME, UNIX
print_value	Optional bool Indique s'il faut imprimer la valeur ou non. La valeur par défaut est True.
microtime	Optional bool Indique s'il faut renvoyer l'heure Unix, y compris la microseconde. La valeur par défaut est False.

Renvoie

Heure de la dernière réussite.

Type renvoyé

Time

TIPCommon.smp_time.get_timestamps

TIPCommon.smp_time.get_timestamps(range_string: str, start_time_string: str, end_time_string: str, error_message: str = None, time_in_milliseconds: bool = False)→ tuple[int, int]

Récupère les codes temporels de début et de fin.

Paramètres

Paramètres
range_string	str Chaîne de période.
start_time_string	str Heure de début.
end_time_string	str Heure de fin.
error_message	str Message d'erreur pour l'exception générée. La valeur par défaut est None.
time_in_milliseconds	bool Définissez si vous souhaitez renvoyer les heures de début et de fin en millisecondes. La valeur par défaut est False.

Renvoie

Codes temporels de début et de fin

Type renvoyé

tuple

TIPCommon.smp_time.get_timestamps_from_range

TIPCommon.smp_time.get_timestamps_from_range(range_string: str, include_timezone: bool = False)→ tuple[datetime, datetime]

Obtient les codes temporels de début et de fin d'une plage.

Paramètres

Paramètres
range_string	str Chaîne de période.
include_timezone	bool, optional Définissez si les informations sur le fuseau horaire doivent être incluses dans les codes temporels. La valeur par défaut est False.

Renvoie

Codes temporels de début et de fin

Type renvoyé

tuple

TIPCommon.smp_time.is_approaching_action_timeout

TIPCommon.smp_time.is_approaching_action_timeout(action_execution_deadline_in_unix, timeout_threshold_in_sec=10)

Vérifie si le script d'action approche de son échéance.

Chaque script d'action est associé à un délai spécifique. Cette fonction vérifie si l'heure actuelle est inférieure à la date limite d'au moins timeout_threshold_in_sec secondes. La valeur par défaut est de 10 secondes. Cela signifie que si l'action se trouve à 10 secondes ou moins de l'échéance de son script (au moment de la vérification), la fonction renvoie True. Si le délai est dépassé, la fonction renvoie False.

Paramètres
action_execution_deadline_in_unix	int Délai d'exécution de l'action.
timeout_threshold_in_sec	int Seuil de délai avant expiration en secondes.

Renvoie

True si le délai d'expiration approche ou False dans tout autre cas.

TIPCommon.smp_time.is_approaching_timeout

TIPCommon.smp_time.is_approaching_timeout(connector_starting_time, python_process_timeout, timeout_threshold=0.9)

Vérifie si un délai avant expiration approche.

Paramètres
connector_starting_time	int Heure de démarrage du connecteur.
python_process_timeout	int Durée maximale d'exécution du connecteur.
timeout_threshold	float Seuil à partir duquel le connecteur est considéré comme approchant d'un délai avant expiration. La valeur par défaut est TIMEOUT_THRESHOLD.

Renvoie

True si le connecteur approche du délai d'expiration ou False dans tout autre cas.

TIPCommon.smp_time.save_timestamp

TIPCommon.smp_time.save_timestamp(siemplify, alerts, timestamp_key='timestamp', incrementation_value=0, log_timestamp=True, convert_timestamp_to_micro_time=False, convert_a_string_timestamp_to_unix=False)

Enregistre le dernier code temporel pour les alertes données.

Paramètres
siemplify	obj Instance de la classe SiemplifyConnectorExecution du SDK.
alerts	dict Liste des alertes permettant de trouver le dernier code temporel.
timestamp_key	Optional str Clé permettant d'obtenir le code temporel à partir de l'alerte. La valeur par défaut est timestamp.
incrementation_value	Optional int Valeur permettant d'incrémenter le dernier code temporel en millisecondes. La valeur par défaut est 0.
log_timestamp	Optional bool Indique s'il faut consigner ou non l'horodatage. La valeur par défaut est True.
convert_timestamp_to_micro_time	Optional bool Indique s'il faut convertir le code temporel en microtemps. La valeur par défaut est False.
convert_a_string_timestamp_to_unix	Optional bool Indique s'il faut convertir un code temporel de chaîne en code temporel Unix. La valeur par défaut est False.

Renvoie

Valeur booléenne indiquant si le code temporel est mis à jour.

TIPCommon.smp_time.siemplify_fetch_timestamp

TIPCommon.smp_time.siemplify_fetch_timestamp(siemplify, datetime_format=False, timezone=False)

Récupère l'horodatage à partir de Siemplify.

Paramètres
siemplify	obj Instance de la classe SiemplifyConnectorExecution du SDK.
datetime_format	Optional bool Indique s'il faut renvoyer le code temporel au format datetime. La valeur par défaut est False.
timezone	Optional bool Indique s'il faut renvoyer l'horodatage dans un fuseau horaire UTC. La valeur par défaut est False.

Renvoie

Horodatage.

TIPCommon.smp_time.siemplify_save_timestamp

TIPCommon.smp_time.siemplify_save_timestamp(siemplify, datetime_format=False, timezone=False, new_timestamp=1696256382032)

Enregistre le code temporel dans Siemplify.

Paramètres
siemplify	obj Instance de la classe SiemplifyConnectorExecution du SDK.
datetime_format	Optional bool Indique s'il faut enregistrer le code temporel au format datetime. La valeur par défaut est False.
timezone	Optional bool Indique s'il faut enregistrer le code temporel dans un fuseau horaire UTC. La valeur par défaut est False.
new_timestamp	Optional int Nouveau code temporel à enregistrer.

Renvoie

Aucun

TIPCommon.smp_time.validate_timestamp

TIPCommon.smp_time.validate_timestamp(last_run_timestamp, offset_in_hours, offset_is_in_days=False)

Valide le code temporel dans une période.

Paramètres
last_run_timestamp	datetime Code temporel de la dernière exécution.
offset_in_hours	int Limite de temps en heures.
offset_is_in_days	Optional bool Indique si le décalage est exprimé en jours. La valeur par défaut est False.

Génère

ValueError : lorsque le code temporel n'est pas valide.

Renvoie

Code temporel validé.

Type renvoyé

datetime

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.