Módulo smp_time

TIPCommon.smp_time.change_timezone

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

Muda o fuso horário de um objeto datetime.datetime.

Parâmetros

Parâmetros
dtime	datetime.datetime O objeto datetime cujo fuso horário foi alterado.
current_tz	str O fuso horário atual.
new_tz	str O fuso horário para mudar.

Retorna

Um novo objeto de data e hora com um novo fuso horário.

Tipo de retorno

datetime.datetime

Gera

ValueError: quando um dos fusos horários não é válido.

TIPCommon.smp_time.convert_string_to_timestamp

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

Converte uma string de data e hora em um carimbo de data/hora.

Parâmetros

Parâmetros
datetime_string	str Uma string de data e hora.

Retorna

O carimbo de data/hora.

Tipo de retorno

int

TIPCommon.smp_time.datetime_to_rfc3339

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

Converte um objeto datetime em uma representação RFC 3999.

Parâmetros

Parâmetros
datetime_obj	datetime.datetime O objeto datetime a ser convertido.

Retorna

A representação RFC 3339 da data e hora.

Tipo de retorno

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)

Recebe a última hora ou data e hora de sucesso.

Parâmetros
siemplify	obj Uma instância da classe SiemplifyConnectorExecution do SDK.
offset_with_metric	dict A métrica e o valor. Exemplo: {'hours': 1}
time_format	int O formato da hora de saída. Exemplo: DATETIME, UNIX
print_value	Opcional bool Indica se o valor deve ser impresso ou não. O padrão é True.
microtime	Opcional bool Indica se é necessário retornar o tempo Unix, incluindo o microtempo. O padrão é False.

Retorna

O horário da última execução bem-sucedida.

Tipo de retorno

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]

Recebe carimbos de data/hora de início e término.

Parâmetros

Parâmetros
range_string	str A string do período.
start_time_string	str O horário de início.
end_time_string	str O horário de término.
error_message	str Uma mensagem de erro para exceção gerada. O valor padrão é None.
time_in_milliseconds	bool Defina se os horários de início e término serão retornados em milissegundos. O valor padrão é False.

Retorna

Os carimbos de data/hora de início e término.

Tipo de retorno

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]

Recebe carimbos de data/hora de início e término de um intervalo.

Parâmetros

Parâmetros
range_string	str A string do período.
include_timezone	bool, optional Defina se as informações de fuso horário devem ser incluídas nos carimbos de data/hora. O valor padrão é False.

Retorna

Os carimbos de data/hora de início e término.

Tipo de retorno

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 se o script de ação está se aproximando do prazo dedicado.

Cada script de ação tem um prazo específico dedicado a ele. Essa função verifica se o horário atual é menor que o prazo em pelo menos timeout_threshold_in_sec segundos. O padrão é de 10 segundos. Isso significa que, se a ação estiver a 10 segundos ou menos do prazo do script (no momento da verificação), a função vai retornar True. Se o prazo for excedido, a função vai retornar False.

Parâmetros
action_execution_deadline_in_unix	int O prazo para a execução da ação.
timeout_threshold_in_sec	int O limite de tempo limite em segundos.

Retorna

True se o tempo limite estiver se aproximando ou False em qualquer outro caso.

TIPCommon.smp_time.is_approaching_timeout

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

Verifica se um tempo limite está se aproximando.

Parâmetros
connector_starting_time	int O horário em que o conector foi iniciado.
python_process_timeout	int O período máximo de tempo que o conector pode ser executado.
timeout_threshold	float O limite em que o conector é considerado como se aproximando de um tempo limite. O padrão é TIMEOUT_THRESHOLD.

Retorna

True se o conector estiver se aproximando de um tempo limite ou False em qualquer outro 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)

Salva o último carimbo de data/hora dos alertas especificados.

Parâmetros
siemplify	obj Uma instância da classe SiemplifyConnectorExecution do SDK.
alerts	dict A lista de alertas para encontrar o último carimbo de data/hora.
timestamp_key	Opcional str A chave para receber o carimbo de data/hora do alerta. O padrão é timestamp.
incrementation_value	Opcional int O valor para incrementar o último carimbo de data/hora em milissegundos. O padrão é 0.
log_timestamp	Opcional bool Indica se o carimbo de data/hora deve ser registrado ou não. O padrão é True.
convert_timestamp_to_micro_time	Opcional bool Indica se o carimbo de data/hora será convertido em microtempo. O padrão é False.
convert_a_string_timestamp_to_unix	Opcional bool Indica se uma string de carimbo de data/hora será convertida para Unix. O padrão é False.

Retorna

Um booleano que indica se o carimbo de data/hora foi atualizado.

TIPCommon.smp_time.siemplify_fetch_timestamp

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

Busca o carimbo de data/hora no Siemplify.

Parâmetros
siemplify	obj Uma instância da classe SiemplifyConnectorExecution do SDK.
datetime_format	Opcional bool Indica se o carimbo de data/hora será retornado no formato datetime. O padrão é False.
timezone	Opcional bool Indica se o carimbo de data/hora deve ser retornado em um fuso horário UTC. O padrão é False.

Retorna

O carimbo de data/hora.

TIPCommon.smp_time.siemplify_save_timestamp

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

Salva o carimbo de data/hora no Siemplify.

Parâmetros
siemplify	obj Uma instância da classe SiemplifyConnectorExecution do SDK.
datetime_format	Opcional bool Indica se o carimbo de data/hora será salvo no formato datetime. O padrão é False.
timezone	Opcional bool Indica se o carimbo de data/hora deve ser salvo em um fuso horário UTC. O padrão é False.
new_timestamp	Opcional int O novo carimbo de data/hora a ser salvo.

Retorna

Nenhuma.

TIPCommon.smp_time.validate_timestamp

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

Valida o carimbo de data/hora em um intervalo de tempo.

Parâmetros
last_run_timestamp	datetime O carimbo de data/hora da última execução.
offset_in_hours	int O limite de tempo em horas.
offset_is_in_days	Opcional bool Indica se o período é em dias. O padrão é False.

Gera

ValueError: quando o carimbo de data/hora não é válido.

Retorna

O carimbo de data/hora validado.

Tipo de retorno

datetime

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.