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

Es el objeto datetime cuya zona horaria se cambia.

current_tz str

Es la zona horaria actual.

new_tz str

Zona horaria a la que se cambiará.

Devoluciones

Es un nuevo objeto datetime con una nueva zona horaria.

Tipo de datos que se muestra

datetime.datetime

Se genera el error

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

Es una cadena de fecha y hora.

Devoluciones

Es la marca de tiempo.

Tipo de datos que se muestra

int

TIPCommon.smp_time.datetime_to_rfc3339

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

Convierte un objeto de fecha y hora en una representación de RFC 3999.

Parámetros

Parámetros
datetime_obj datetime.datetime

Es el objeto datetime que se convertirá.

Devoluciones

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

Tipo de datos que se muestra

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 fecha y hora de éxito.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

offset_with_metric dict

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

time_format int

Es 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

Es la última hora de éxito.

Tipo de datos que se muestra

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

Es la cadena del intervalo de tiempo.

start_time_string str

La hora de inicio.

end_time_string str

Es la hora de finalización.

error_message str

Es un mensaje de error para la excepción generada.

La configuración predeterminada es None.

time_in_milliseconds bool

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

La configuración predeterminada es False.

Devoluciones

Marcas de tiempo de la hora de inicio y la hora de finalización

Tipo de datos que se muestra

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

Es la cadena del intervalo de tiempo.

include_timezone bool, optional

Define si se debe incluir información de la zona horaria en las marcas de tiempo.

La configuración predeterminada es False.

Devoluciones

Marcas de tiempo de la hora de inicio y la hora de finalización

Tipo de datos que se muestra

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)

Verifica si el script de acción se acerca a la fecha límite del script dedicado.

Cada secuencia de comandos de acción tiene una fecha límite específica. Esta función verifica si la hora actual es anterior 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 está a 10 segundos o menos de la fecha límite de la secuencia de comandos (en el momento de la verificación), la función devuelve True. Si se supera el plazo, la función devuelve False.

Parámetros
action_execution_deadline_in_unix int

Es la fecha límite para la ejecución de la acción.

timeout_threshold_in_sec int

Es el 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

Es la fecha y hora en que se inició el conector.

python_process_timeout int

Es la cantidad máxima de tiempo que se permite que se ejecute el conector.

timeout_threshold float

Es el umbral en el que se considera que el conector se acerca a un tiempo de espera agotado.El valor predeterminado es TIMEOUT_THRESHOLD.

Devoluciones

True si el conector se acerca a un 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 para las alertas determinadas.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

alerts dict

Es la lista de alertas para encontrar la última marca de tiempo.

timestamp_key Optional

str

Es 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.
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 en Unix.
El valor predeterminado es False.

Devoluciones

Es un valor booleano que indica si se actualizó la marca de tiempo.

TIPCommon.smp_time.siemplify_fetch_timestamp

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

Recupera la marca de tiempo de Siemplify.

Parámetros
siemplify obj

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 una zona horaria UTC.
El valor predeterminado es False.

Devoluciones

Es la 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

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

Es la nueva marca de tiempo que se 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.

Parámetros
last_run_timestamp datetime

Es la marca de tiempo de la última ejecución.

offset_in_hours int

Es el límite de tiempo en horas.

offset_is_in_days Optional

bool

Indica si el desplazamiento está en días.
El valor predeterminado es False.

Se genera el error

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

Devoluciones

Es la marca de tiempo validada.

Tipo de datos que se muestra

datetime

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.