módulo smp_io
TIPCommon.smp_io.read_and_repair_existing_ids
TIPCommon.smp_io.read_and_repair_existing_ids(siemplify: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, default_value_to_return: dict = None, identifier: str = None, ids_file_name: str = 'ids.json', db_key: str = 'ids')→ list
Lê os IDs de alertas existentes e converte-os numa lista se forem um dicionário. Isto é necessário para evitar regressões.
Parâmetros
Parâmetros | |
---|---|
siemplify |
SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob Uma instância do SOAR SDK do Google Security Operations. |
default_value_to_return |
dict | list | string O valor predefinido a definir quando é criado um novo ficheiro ou chave. Se não for fornecido nenhum valor, é definida uma predefinição interna de |
identifier |
str O atributo do identificador do conetor. |
ids_file_name |
str O nome do ficheiro onde os IDs devem ser guardados quando um objeto |
db_key |
str O nome da chave onde os IDs devem ser guardados quando um objeto |
Devoluções
Uma lista de IDs no objeto DataStream.
Tipo devolvido
list
TIPCommon.smp_io.read_content
TIPCommon.smp_io.read_content(siemplify, file_name, db_key, default_value_to_return=None, identifier=None)
Ler o conteúdo de um objeto ConnectorStream. Se o objeto não contiver dados ou não existir, devolva um valor predefinido.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
file_name |
str O nome do ficheiro a validar (quando a plataforma usa ficheiros). |
db_key |
str O nome da chave a validar (quando a plataforma usa uma base de dados). |
default_value_to_return |
dict/list/str O valor predefinido definido quando são criados um novo ficheiro e uma nova chave. Se não for fornecido nenhum valor, é definido um valor predefinido interno de
|
identifier |
str O atributo do identificador do conetor. |
Devoluções
(dict)
O conteúdo no objeto DataStream
.
O conteúdo passa por json.loads
antes de ser devolvido.
TIPCommon.smp_io.read_ids
TIPCommon.smp_io.read_ids(siemplify, default_value_to_return=None, identifier=None, ids_file_name='ids.json', db_key='ids')
Lê IDs de um objeto ConnectorStream. Se o objeto não contiver dados ou não existir, devolva um valor predefinido.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
ids_file_name |
sttr O nome do ficheiro onde os IDs devem ser guardados quando um objeto |
db_key |
str O nome da chave onde os IDs devem ser guardados quando um objeto |
default_value_to_return |
dict/list/str O valor predefinido a definir no caso de serem criados um novo ficheiro e uma nova chave. Se não for fornecido nenhum valor, é definido um valor predefinido interno |
identifier |
str O atributo do identificador do conetor. |
Devoluções
(list)
Uma lista de IDs no objeto DataStream.
O conteúdo passa por
json.loads
antes de ser devolvido.
TIPCommon.smp_io.read_ids_by_timestamp
TIPCommon.smp_io.read_ids_by_timestamp(siemplify, offset_in_hours=72, default_value_to_return=None, convert_to_milliseconds=False, cast_keys_to_integers=False, offset_is_in_days=False, identifier=None, ids_file_name='ids.json', db_key='ids')
Lê IDs de um objeto ConnectorStream. Se o objeto não contiver dados ou não existir, devolva um valor predefinido.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
offset_in_hours |
int O limite de tempo (valor de deslocamento) do ID em horas. |
convert_to_milliseconds |
bool Transforme a indicação de tempo (Unix) de cada ID de segundos para milissegundos. |
cast_keys_to_integers |
bool Converta as chaves em números inteiros. |
offset_is_in_days |
bool Se o desvio fornecido a este método estiver em dias,
defina o parâmetro como |
ids_file_name |
str O nome do ficheiro onde os IDs devem ser guardados quando um objeto |
db_key |
str O nome da chave onde os IDs devem ser guardados quando um objeto |
default_value_to_return |
dict/list/str O valor predefinido a definir no caso de serem criados um novo ficheiro e uma nova chave. |
identifier |
str O atributo do identificador do conetor. |
Devoluções
(list)
Uma lista de IDs no objeto DataStream. O conteúdo passa por
json.loads
antes de ser devolvido.
TIPCommon.smp_io.write_content
TIPCommon.smp_io.write_content(siemplify, content_to_write, file_name, db_key, default_value_to_set=None, identifier=None)
Escreve conteúdo num objeto ConnectorStream.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
content_to_write |
dict/list/str O conteúdo a ser escrito na stream de dados dedicada. |
file_name |
str O nome do ficheiro. |
db_key |
str O nome da chave. |
default_value_to_set |
dict/list/str O valor predefinido definido quando são criados um novo ficheiro e uma nova chave. |
identifier |
str O atributo do identificador do conetor. |
Devoluções
Nenhum.
TIPCommon.smp_io.write_ids
TIPCommon.smp_io.write_ids(siemplify, ids, default_value_to_set=None, stored_ids_limit=1000, identifier=None, ids_file_name='ids.json', db_key='ids')
Escreve os últimos 1000 IDs num objeto ConnectorStream.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
ids |
list/str Os IDs a escrever na stream de dados dedicada. |
stored_ids_limit |
int O número de IDs recentes dos IDs existentes que vão ser escritos. |
ids_file_name |
str O nome do ficheiro onde os IDs devem ser guardados quando um objeto |
db_key |
str O nome da chave onde os IDs devem ser guardados quando um objeto |
default_value_to_set |
dict/list/str O valor predefinido definido quando são criados um novo ficheiro e uma nova chave. |
identifier |
str O atributo do identificador do conetor. |
Devoluções
Nenhum.
TIPCommon.smp_io.write_ids_with_timestamp
TIPCommon.smp_io.write_ids_with_timestamp(siemplify, ids, default_value_to_set=None, identifier=None, ids_file_name='ids.json', db_key='ids')
Escreve IDs num objeto ConnectorStream com uma data/hora.
Parâmetros | |
---|---|
siemplify |
obj Uma instância da classe
|
ids |
list/str Os IDs a escrever na stream de dados dedicada. |
ids_file_name |
str O nome do ficheiro onde os IDs devem ser guardados quando um objeto |
db_key |
str O nome da chave onde os IDs devem ser guardados quando um objeto |
default_value_to_set |
dict/list/str O valor predefinido a definir no caso de serem criados um novo ficheiro e uma nova chave. |
identifier |
str O atributo do identificador do conetor. |
Devoluções
Nenhum.
Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.