Módulo smp_time

TIPCommon.smp_time.change_timezone

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

Cambia la zona horaria de un objeto datetime.datetime.

Parámetros

Parámetros
dtime datetime.datetime

El objeto datetime cuya zona horaria se ha cambiado.

current_tz str

La zona horaria actual.

new_tz str

La zona horaria a la que se va a cambiar.

Devoluciones

Un nuevo objeto datetime con una nueva zona horaria.

Tipo de devolución

datetime.datetime

Aumentos

ValueError: cuando una de las zonas horarias no es válida.

TIPCommon.smp_time.convert_string_to_timestamp

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

Convierte una cadena de fecha y hora en una marca de tiempo.

Parámetros

Parámetros
datetime_string str

Una cadena de fecha y hora.

Devoluciones

Marca de tiempo.

Tipo de devolución

int

TIPCommon.smp_time.datetime_to_rfc3339

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

Convierte un objeto datetime en una representación RFC 3999.

Parámetros

Parámetros
datetime_obj datetime.datetime

El objeto datetime que se va a convertir.

Devoluciones

Representación RFC 3339 de la fecha y la hora.

Tipo de devolución

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)

Obtiene la última hora o fecha y hora de éxito.

Parámetros
siemplify obj

Una instancia de la clase SiemplifyConnectorExecution del SDK.

offset_with_metric dict

La métrica y el valor.
Ejemplo: {'hours': 1}

time_format int

El formato de la hora de salida.
Ejemplo: DATETIME, UNIX

print_value Optional

bool

Indica si se debe imprimir el valor.
El valor predeterminado es True.

microtime Optional

bool

Indica si se debe devolver la hora Unix, incluida la hora en microsegundos.
El valor predeterminado es False.

Devoluciones

La hora de la última operación correcta.

Tipo de devolución

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]

Obtiene las marcas de tiempo de inicio y finalización.

Parámetros

Parámetros
range_string str

Cadena del periodo.

start_time_string str

La hora de inicio.

end_time_string str

La hora de finalización.

error_message str

Mensaje de error de la excepción generada.

El valor predeterminado es None.

time_in_milliseconds bool

Define si se debe devolver la hora de inicio y la de finalización en milisegundos.

El valor predeterminado es False.

Devoluciones

Las marcas de tiempo de inicio y finalización.

Tipo de devolución

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]

Obtiene las marcas de tiempo de inicio y finalización de un intervalo.

Parámetros

Parámetros
range_string str

Cadena del periodo.

include_timezone bool, optional

Define si quieres incluir información sobre la zona horaria en las marcas de tiempo.

El valor predeterminado es False.

Devoluciones

Las marcas de tiempo de inicio y finalización.

Tipo de devolución

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)

Comprueba si la secuencia de comandos de la acción se acerca a su plazo de secuencia de comandos específico.

Cada secuencia de comandos de acción tiene un plazo específico. Esta función comprueba si la hora actual es inferior a la fecha límite en al menos timeout_threshold_in_sec segundos. El valor predeterminado es 10 segundos, lo que significa que, si la acción se realiza 10 segundos o menos antes de la fecha límite de la secuencia de comandos (en el momento de la comprobación), la función devuelve True. Si se supera el plazo, la función devuelve False.

Parámetros
action_execution_deadline_in_unix int

Fecha límite para ejecutar la acción.

timeout_threshold_in_sec int

Umbral de tiempo de espera en segundos.

Devoluciones

True si se acerca el tiempo de espera o False en cualquier otro caso.

TIPCommon.smp_time.is_approaching_timeout

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

Comprueba si se acerca un tiempo de espera.

Parámetros
connector_starting_time int

La hora a la que se inició el conector.

python_process_timeout int

El tiempo máximo que se permite que se ejecute el conector.

timeout_threshold float

Umbral en el que se considera que el conector se acerca al tiempo de espera.
El valor predeterminado es TIMEOUT_THRESHOLD.

Devoluciones

True si el conector está a punto de agotar el tiempo de espera o False en cualquier otro caso.

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)

Guarda la última marca de tiempo de las alertas proporcionadas.

Parámetros
siemplify obj

Una instancia de la clase SiemplifyConnectorExecution del SDK.

alerts dict

Lista de alertas para encontrar la última marca de tiempo.

timestamp_key Optional

str

La clave para obtener la marca de tiempo de la alerta.
El valor predeterminado es timestamp.

incrementation_value Optional

int

Valor para incrementar la última marca de tiempo en milisegundos.
El valor predeterminado es 0.

log_timestamp Optional

bool

Indica si se debe registrar la marca de tiempo o no.
El valor predeterminado es True.

convert_timestamp_to_micro_time Optional

bool

Indica si se debe convertir la marca de tiempo a microtiempo.
El valor predeterminado es False.

convert_a_string_timestamp_to_unix Optional

bool

Indica si se debe convertir una marca de tiempo de cadena a Unix.
El valor predeterminado es False.

Devoluciones

Valor booleano que indica si se ha actualizado la marca de tiempo.

TIPCommon.smp_time.siemplify_fetch_timestamp

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

Obtiene la marca de tiempo de Siemplify.

Parámetros
siemplify obj

Una instancia de la clase SiemplifyConnectorExecution del SDK.

datetime_format Optional

bool

Indica si se debe devolver la marca de tiempo en formato datetime.
El valor predeterminado es False.

timezone Optional

bool

Indica si se debe devolver la marca de tiempo en la zona horaria UTC.
El valor predeterminado es False.

Devoluciones

Marca de tiempo.

TIPCommon.smp_time.siemplify_save_timestamp

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

Guarda la marca de tiempo en Siemplify.

Parámetros
siemplify obj

Una instancia de la clase SiemplifyConnectorExecution del SDK.

datetime_format Optional

bool

Indica si se debe guardar la marca de tiempo en formato datetime.
El valor predeterminado es False.

timezone Optional

bool

Indica si se debe guardar la marca de tiempo en una zona horaria UTC.
El valor predeterminado es False.

new_timestamp Optional

int

La nueva marca de tiempo que se va a guardar.

Devoluciones

Ninguno

TIPCommon.smp_time.validate_timestamp

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

Valida la marca de tiempo en un intervalo de tiempo.

Parámetros
last_run_timestamp datetime

Marca de tiempo de la última ejecución.

offset_in_hours int

El límite de tiempo en horas.

offset_is_in_days Optional

bool

Indica si el desfase es en días.
El valor predeterminado es False.

Aumentos

ValueError: cuando la marca de tiempo no es válida.

Devoluciones

Marca de tiempo validada.

Tipo de devolución

datetime

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.