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

Lee los IDs de alertas existentes y los convierte en una lista si son un diccionario. Esto es necesario para evitar regresiones.

Parámetros

Parámetros
siemplify SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob

Es una instancia del SDK de Google Security Operations SOAR.

default_value_to_return dict | list | string

Es el valor predeterminado que se establecerá cuando se cree un archivo o una clave nuevos. Si no se proporciona ningún valor, se establecerá un valor predeterminado interno de [] (list) como el nuevo valor predeterminado.

identifier str

Es el atributo identificador del conector.

ids_file_name str

Nombre del archivo en el que se deben guardar los IDs cuando se crea un objeto FileStream.

db_key str

Es el nombre de la clave en la que se deben guardar los IDs cuando se crea un objeto FileStream.

Devoluciones

Es una lista de IDs dentro del objeto DataStream.

Tipo de datos que se muestra

list

TIPCommon.smp_io.read_content

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

Lee el contenido de un objeto ConnectorStream. Si el objeto no contiene datos o no existe, devuelve un valor predeterminado.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

file_name str

Nombre del archivo que se validará (cuando la plataforma usa archivos).

db_key str

Es el nombre de la clave que se validará (cuando la plataforma usa una base de datos).

default_value_to_return dict/list/str

Es el valor predeterminado que se establece cuando se crean un archivo y una clave nuevos. Si no se proporciona ningún valor, se establece un valor predeterminado interno de {} (dict) como el nuevo valor predeterminado.

identifier str

Es el atributo identificador del conector.

Devoluciones

(dict) Es el contenido dentro del objeto DataStream. El contenido pasa por json.loads antes de regresar.

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

Lee IDs de un objeto ConnectorStream. Si el objeto no contiene datos o no existe, devuelve un valor predeterminado.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

ids_file_name sttr

Es el nombre de archivo en el que se deben guardar los IDs cuando se crea un objeto FileStream.

db_key str

Nombre de la clave en la que se deben guardar los IDs cuando se crea un objeto FileStream.

default_value_to_return dict/list/str

Es el valor predeterminado que se establecerá en caso de que se creen un archivo y una clave nuevos. Si no se proporciona ningún valor, se establece un valor predeterminado interno [] (list) como el nuevo valor predeterminado.

identifier str

Es el atributo identificador del conector.

Devoluciones

(list) Es una lista de IDs dentro del objeto DataStream. El contenido pasa por json.loads antes de regresar.

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

Lee IDs de un objeto ConnectorStream. Si el objeto no contiene datos o no existe, devuelve un valor predeterminado.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

offset_in_hours int

Es el límite de tiempo (valor de desplazamiento) del ID en horas.

convert_to_milliseconds bool

Transforma la marca de tiempo (Unix) de cada ID de segundos a milisegundos.

cast_keys_to_integers bool

Convierte las claves en números enteros.

offset_is_in_days bool

Si el desplazamiento proporcionado a este método está en días, establece el parámetro en True para convertir los días de desplazamiento en horas.

ids_file_name str

Es el nombre de archivo en el que se deben guardar los IDs cuando se crea un objeto FileStream.

db_key str

Nombre de la clave en la que se deben guardar los IDs cuando se crea un objeto FileStream.

default_value_to_return dict/list/str

Es el valor predeterminado que se establecerá en caso de que se creen un archivo y una clave nuevos.

identifier str

Es el atributo identificador del conector.

Devoluciones

(list) Es una lista de IDs dentro del objeto DataStream. El contenido pasa por json.loads antes de regresar.

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)

Escribe contenido en un objeto ConnectorStream.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

content_to_write dict/list/str

Es el contenido que se escribirá en el flujo de datos dedicado.

file_name str

Es el nombre del archivo.

db_key str

Es el nombre de la clave.

default_value_to_set dict/list/str

Es el valor predeterminado que se establece cuando se crean un archivo y una clave nuevos.

identifier str

Es el atributo identificador del conector.

Devoluciones

Ninguno

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

Escribe los últimos 1,000 IDs en un objeto ConnectorStream.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

ids list/str

Son los IDs que se escribirán en el flujo de datos dedicado.

stored_ids_limit int

Cantidad de IDs recientes de los IDs existentes que se escribirán.

ids_file_name str

Es el nombre de archivo en el que se deben guardar los IDs cuando se crea un objeto FileStream.

db_key str

Nombre de la clave en la que se deben guardar los IDs cuando se crea un objeto FileStream.

default_value_to_set dict/list/str

Es el valor predeterminado que se establece cuando se crean un archivo y una clave nuevos.

identifier str

Es el atributo identificador del conector.

Devoluciones

Ninguno

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

Escribe IDs en un objeto ConnectorStream con una marca de tiempo.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK

ids list/str

Son los IDs que se escribirán en el flujo de datos dedicado.

ids_file_name str

Es el nombre de archivo en el que se deben guardar los IDs cuando se crea un objeto FileStream.

db_key str

Nombre de la clave en la que se deben guardar los IDs cuando se crea un objeto FileStream.

default_value_to_set dict/list/str

Es el valor predeterminado que se establecerá en caso de que se creen un archivo y una clave nuevos.

identifier str

Es el atributo identificador del conector.

Devoluciones

Ninguno

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