Módulo smp_time

TIPCommon.smp_time.change_timezone

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

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

Parâmetros

Parâmetros
dtime datetime.datetime

O objeto datetime cujo fuso horário é alterado.

current_tz str

O fuso horário atual.

new_tz str

O fuso horário para o qual quer alterar.

Devoluções

Um novo objeto datetime com um novo fuso horário.

Tipo devolvido

datetime.datetime

Aumenta

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/hora numa data/hora.

Parâmetros

Parâmetros
datetime_string str

Uma string de data/hora.

Devoluções

A data/hora.

Tipo devolvido

int

TIPCommon.smp_time.datetime_to_rfc3339

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

Converte um objeto datetime na representação RFC 3999.

Parâmetros

Parâmetros
datetime_obj datetime.datetime

O objeto datetime a converter.

Devoluções

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

Tipo devolvido

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)

Obtém a hora ou a data/hora do último êxito.

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 valor predefinido é True.

microtime Opcional

bool

Indica se deve devolver a hora Unix, incluindo a hora em microssegundos.
A predefinição é False.

Devoluções

A hora do último êxito.

Tipo devolvido

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]

Obtém as datas/horas de início e de fim.

Parâmetros

Parâmetros
range_string str

A string do intervalo de tempo.

start_time_string str

A hora de início.

end_time_string str

A hora de fim.

error_message str

Uma mensagem de erro para a exceção gerada.

A predefinição é None.

time_in_milliseconds bool

Defina se deve devolver a hora de início e a hora de fim em milissegundos.

A predefinição é False.

Devoluções

As indicações de tempo das horas de início e de fim.

Tipo devolvido

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]

Obtém indicações de tempo de início e de fim a partir de um intervalo.

Parâmetros

Parâmetros
range_string str

A string do intervalo de tempo.

include_timezone bool, optional

Defina se quer incluir informações de fuso horário nas indicações de tempo.

A predefinição é False.

Devoluções

As indicações de tempo das horas de início e de fim.

Tipo devolvido

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 se está a aproximar do prazo dedicado do script.

Cada script de ação tem um prazo específico dedicado. Esta função verifica se a hora atual é inferior à data/hora limite em, pelo menos, timeout_threshold_in_sec segundos. O valor predefinido é 10 segundos, o que significa que, se a ação estiver a 10 segundos ou menos do prazo do respetivo script (no momento da verificação), a função devolve True. Se o prazo for excedido, a função devolve 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 em segundos.

Devoluções

True se o tempo limite estiver a aproximar-se 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á a aproximar-se.

Parâmetros
connector_starting_time int

A hora em que o conetor foi iniciado.

python_process_timeout int

O tempo máximo que o conector pode ser executado.

timeout_threshold float

O limite a partir do qual o conetor é considerado como estando a aproximar-se de um limite de tempo.
O valor predefinido é TIMEOUT_THRESHOLD.

Devoluções

True se o conector estiver a aproximar-se de um limite de tempo 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)

Guarda a data/hora mais recente dos alertas fornecidos.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

alerts dict

A lista de alertas para encontrar a data/hora mais recente.

timestamp_key Opcional

str

A chave para obter a data/hora do alerta.
A predefinição é timestamp.

incrementation_value Opcional

int

O valor para incrementar a data/hora mais recente em milissegundos.
O valor predefinido é 0.

log_timestamp Opcional

bool

Indica se a data/hora deve ser registada ou não.
A predefinição é True.

convert_timestamp_to_micro_time Opcional

bool

Indica se a data/hora deve ser convertida em microtempo.
A predefinição é False.

convert_a_string_timestamp_to_unix Opcional

bool

Indica se deve converter uma data/hora de string para Unix.
O valor predefinido é False.

Devoluções

Um valor booleano que indica se a indicação de tempo é atualizada.

TIPCommon.smp_time.siemplify_fetch_timestamp

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

Obtém a data/hora do Siemplify.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

datetime_format Opcional

bool

Indica se a data/hora deve ser devolvida num formato datetime.
A predefinição é False.

timezone Opcional

bool

Indica se a data/hora deve ser devolvida num fuso horário UTC.
A predefinição é False.

Devoluções

A data/hora.

TIPCommon.smp_time.siemplify_save_timestamp

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

Guarda a data/hora no Siemplify.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

datetime_format Opcional

bool

Indica se deve guardar a data/hora num formato datetime.
A predefinição é False.

timezone Opcional

bool

Indica se a data/hora deve ser guardada num fuso horário UTC.
A predefinição é False.

new_timestamp Opcional

int

A nova indicação de tempo a guardar.

Devoluções

Nenhum.

TIPCommon.smp_time.validate_timestamp

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

Valida a data/hora num intervalo de tempo.

Parâmetros
last_run_timestamp datetime

A 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 desvio está em dias.
A predefinição é False.

Aumenta

ValueError: quando a data/hora não é válida.

Devoluções

A data/hora validada.

Tipo devolvido

datetime

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