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 alerta atuais e os converte em uma lista se forem um dicionário. Isso é necessário para evitar regressões.

Parâmetros

Parâmetros
siemplify SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob

Uma instância do SDK do SOAR do Google Security Operations.

default_value_to_return dict | list | string

O valor padrão a ser definido quando um novo arquivo ou chave é criado. Se nenhum valor for fornecido, um padrão interno de [] (list) será definido como o novo valor padrão.

identifier str

O atributo identificador do conector.

ids_file_name str

O nome do arquivo em que os IDs serão salvos quando um objeto FileStream for criado.

db_key str

O nome da chave em que os IDs devem ser salvos quando um objeto FileStream é criado.

Retorna

Uma lista de IDs dentro do objeto DataStream.

Tipo de retorno

list

TIPCommon.smp_io.read_content

TIPCommon.smp_io.read_content(siemplify, file_name, db_key, default_value_to_return=None, identifier=None)

Leia o conteúdo de um objeto ConnectorStream. Se o objeto não contiver dados ou não existir, retorne um valor padrão.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

file_name str

O nome do arquivo a ser validado (quando a plataforma usa arquivos).

db_key str

O nome da chave a ser validada (quando a plataforma usa um banco de dados).

default_value_to_return dict/list/str

O valor padrão definido quando um novo arquivo e uma chave são criados. Se nenhum valor for fornecido, um valor padrão interno de {} (dict) será definido como o novo valor padrão.

identifier str

O atributo identificador do conector.

Retorna

(dict) O conteúdo dentro do objeto DataStream. O conteúdo passa por json.loads antes de ser retornado.

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, retorne um valor padrão.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

ids_file_name sttr

O nome do arquivo em que os IDs serão salvos quando um objeto FileStream for criado.

db_key str

O nome da chave em que os IDs serão salvos quando um objeto FileStream for criado.

default_value_to_return dict/list/str

O valor padrão a ser definido quando um novo arquivo e uma nova chave são criados. Se nenhum valor for fornecido, um valor padrão interno [] (list) será definido como o novo valor padrão.

identifier str

O atributo identificador do conector.

Retorna

(list) Uma lista de IDs dentro do objeto DataStream. O conteúdo passa por json.loads antes de ser retornado.

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, retorne um valor padrão.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

offset_in_hours int

O limite de tempo (valor de ajuste) do ID em horas.

convert_to_milliseconds bool

Transforme o carimbo de data/hora (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 a compensação fornecida a esse método for em dias, defina o parâmetro como True para converter os dias de compensação em horas.

ids_file_name str

O nome do arquivo em que os IDs serão salvos quando um objeto FileStream for criado.

db_key str

O nome da chave em que os IDs serão salvos quando um objeto FileStream for criado.

default_value_to_return dict/list/str

O valor padrão a ser definido quando um novo arquivo e uma nova chave são criados.

identifier str

O atributo identificador do conector.

Retorna

(list) Uma lista de IDs dentro do objeto DataStream. O conteúdo passa por json.loads antes de ser retornado.

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)

Grava conteúdo em um objeto ConnectorStream.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

content_to_write dict/list/str

O conteúdo a ser gravado no fluxo de dados dedicado.

file_name str

O nome do arquivo.

db_key str

O nome da chave.

default_value_to_set dict/list/str

O valor padrão definido quando um novo arquivo e uma chave são criados.

identifier str

O atributo identificador do conector.

Retorna

Nenhuma.

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')

Grava os últimos 1.000 IDs em um objeto ConnectorStream.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

ids list/str

Os IDs a serem gravados no fluxo de dados dedicado.

stored_ids_limit int

O número de IDs recentes dos IDs atuais que serão gravados.

ids_file_name str

O nome do arquivo em que os IDs serão salvos quando um objeto FileStream for criado.

db_key str

O nome da chave em que os IDs serão salvos quando um objeto FileStream for criado.

default_value_to_set dict/list/str

O valor padrão definido quando um novo arquivo e uma chave são criados.

identifier str

O atributo identificador do conector.

Retorna

Nenhuma.

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')

Grava IDs em um objeto ConnectorStream com um carimbo de data/hora.

Parâmetros
siemplify obj

Uma instância da classe SiemplifyConnectorExecution do SDK.

ids list/str

Os IDs a serem gravados no fluxo de dados dedicado.

ids_file_name str

O nome do arquivo em que os IDs serão salvos quando um objeto FileStream for criado.

db_key str

O nome da chave em que os IDs serão salvos quando um objeto FileStream for criado.

default_value_to_set dict/list/str

O valor padrão a ser definido quando um novo arquivo e uma nova chave são criados.

identifier str

O atributo identificador do conector.

Retorna

Nenhuma.

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