smp_time-Modul

TIPCommon.smp_time.change_timezone

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

Ändert die Zeitzone eines datetime.datetime-Objekts.

Parameter

Parameter
dtime	datetime.datetime Das DateTime-Objekt, dessen Zeitzone geändert wird.
current_tz	str Die aktuelle Zeitzone.
new_tz	str Die Zeitzone, in die gewechselt werden soll.

Gibt Folgendes zurück:

Ein neues datetime-Objekt mit einer neuen Zeitzone.

Rückgabetyp

datetime.datetime

Löst aus

ValueError: Wenn eine der Zeitzonen ungültig ist.

TIPCommon.smp_time.convert_string_to_timestamp

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

Konvertiert einen Datetime-String in einen Zeitstempel.

Parameter

Parameter
datetime_string	str Ein Datetime-String.

Gibt Folgendes zurück:

Der Zeitstempel.

Rückgabetyp

int

TIPCommon.smp_time.datetime_to_rfc3339

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

Wandelt ein datetime-Objekt in die RFC 3999-Darstellung um.

Parameter

Parameter
datetime_obj	datetime.datetime Das DateTime-Objekt, das konvertiert werden soll.

Gibt Folgendes zurück:

Die RFC 3339-Darstellung des Datums und der Uhrzeit.

Rückgabetyp

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)

Ruft die letzte Erfolgszeit oder das letzte Erfolgsdatum ab.

Parameter
siemplify	obj Eine Instanz der SDK-Klasse SiemplifyConnectorExecution.
offset_with_metric	dict Der Messwert und der Wert. Beispiel: {'hours': 1}
time_format	int Das Format der Ausgabedauer. Beispiel: DATETIME, UNIX
print_value	Optional bool Gibt an, ob der Wert ausgegeben werden soll oder nicht. Der Standardwert ist True.
microtime	Optional bool Gibt an, ob die Unix-Zeit einschließlich Mikrosekunden zurückgegeben werden soll. Der Standardwert ist False.

Gibt Folgendes zurück:

Die Zeit des letzten Erfolgs.

Rückgabetyp

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]

Ruft Start- und Endzeitstempel ab.

Parameter

Parameter
range_string	str Der Zeitraum-String.
start_time_string	str Die Startzeit.
end_time_string	str Die Endzeit.
error_message	str Eine Fehlermeldung für die ausgelöste Ausnahme. Die Standardeinstellung ist None.
time_in_milliseconds	bool Geben Sie an, ob Start- und Endzeit in Millisekunden zurückgegeben werden sollen. Die Standardeinstellung ist False.

Gibt Folgendes zurück:

Die Zeitstempel für Start- und Endzeit.

Rückgabetyp

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]

Ruft Start- und Endzeitstempel aus einem Bereich ab.

Parameter

Parameter
range_string	str Der Zeitraum-String.
include_timezone	bool, optional Legen Sie fest, ob Zeitstempel Informationen zur Zeitzone enthalten sollen. Die Standardeinstellung ist False.

Gibt Folgendes zurück:

Die Zeitstempel für Start- und Endzeit.

Rückgabetyp

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)

Prüft, ob das Aktionsskript die zugehörige Skript-Deadline erreicht.

Für jedes Aktionsskript gilt eine bestimmte Frist. Diese Funktion prüft, ob die aktuelle Zeit mindestens timeout_threshold_in_sec Sekunden vor dem Ablauf der Frist liegt. Der Standardwert ist 10 Sekunden. Wenn die Aktion also zum Zeitpunkt der Prüfung noch 10 Sekunden oder weniger bis zur Script-Deadline hat, gibt die Funktion True zurück. Wenn die Frist überschritten wird, gibt die Funktion False zurück.

Parameter
action_execution_deadline_in_unix	int Das Zeitlimit für die Ausführung der Aktion.
timeout_threshold_in_sec	int Der Timeout-Grenzwert in Sekunden.

Gibt Folgendes zurück:

True, wenn das Zeitlimit bald erreicht ist, oder False in allen anderen Fällen.

TIPCommon.smp_time.is_approaching_timeout

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

Prüft, ob ein Zeitlimit erreicht wird.

Parameter
connector_starting_time	int Der Zeitpunkt, zu dem der Connector gestartet wurde.
python_process_timeout	int Die maximale Zeit, die der Connector ausgeführt werden darf.
timeout_threshold	float Der Grenzwert, ab dem der Connector als kurz vor einem Zeitlimit gilt. Der Standardwert ist TIMEOUT_THRESHOLD.

Gibt Folgendes zurück:

True, wenn der Connector kurz vor einem Zeitüberschreitungsfehler steht, oder False in allen anderen Fällen.

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)

Speichert den letzten Zeitstempel für die angegebenen Benachrichtigungen.

Parameter
siemplify	obj Eine Instanz der SDK-Klasse SiemplifyConnectorExecution.
alerts	dict Die Liste der Benachrichtigungen, in der der letzte Zeitstempel zu finden ist.
timestamp_key	Optional str Der Schlüssel zum Abrufen des Zeitstempels aus der Benachrichtigung. Der Standardwert ist timestamp.
incrementation_value	Optional int Der Wert, um den der letzte Zeitstempel in Millisekunden erhöht werden soll. Der Standardwert ist 0.
log_timestamp	Optional bool Gibt an, ob der Zeitstempel protokolliert werden soll. Der Standardwert ist True.
convert_timestamp_to_micro_time	Optional bool Gibt an, ob der Zeitstempel in Mikrosekunden umgerechnet werden soll. Der Standardwert ist False.
convert_a_string_timestamp_to_unix	Optional bool Gibt an, ob ein String-Zeitstempel in Unix konvertiert werden soll. Der Standardwert ist False.

Gibt Folgendes zurück:

Ein boolescher Wert, der angibt, ob der Zeitstempel aktualisiert wird.

TIPCommon.smp_time.siemplify_fetch_timestamp

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

Ruft den Zeitstempel aus Siemplify ab.

Parameter
siemplify	obj Eine Instanz der SDK-Klasse SiemplifyConnectorExecution.
datetime_format	Optional bool Gibt an, ob der Zeitstempel im Format datetime zurückgegeben werden soll. Der Standardwert ist False.
timezone	Optional bool Gibt an, ob der Zeitstempel in der UTC-Zeitzone zurückgegeben werden soll. Der Standardwert ist False.

Gibt Folgendes zurück:

Der Zeitstempel.

TIPCommon.smp_time.siemplify_save_timestamp

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

Speichert den Zeitstempel in Siemplify.

Parameter
siemplify	obj Eine Instanz der SDK-Klasse SiemplifyConnectorExecution.
datetime_format	Optional bool Gibt an, ob der Zeitstempel im Format datetime gespeichert werden soll. Der Standardwert ist False.
timezone	Optional bool Gibt an, ob der Zeitstempel in der UTC-Zeitzone gespeichert werden soll. Der Standardwert ist False.
new_timestamp	Optional int Der neue Zeitstempel, der gespeichert werden soll.

Gibt Folgendes zurück:

Keine.

TIPCommon.smp_time.validate_timestamp

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

Validiert den Zeitstempel in einem Zeitraum.

Parameter
last_run_timestamp	datetime Der Zeitstempel der letzten Ausführung.
offset_in_hours	int Das Zeitlimit in Stunden.
offset_is_in_days	Optional bool Gibt an, ob der Offset in Tagen angegeben wird. Der Standardwert ist False.

Löst aus

ValueError: Wenn der Zeitstempel ungültig ist.

Gibt Folgendes zurück:

Der validierte Zeitstempel.

Rückgabetyp

datetime

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten