Module 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

Lit les ID d'alerte existants et les convertit en liste s'ils sont un dictionnaire. Cela est nécessaire pour éviter les régressions.

Paramètres

Paramètres
siemplify SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob

Instance du SDK Google Security Operations SOAR.

default_value_to_return dict | list | string

Valeur par défaut à définir lorsqu'un fichier ou une clé est créé. Si aucune valeur n'est fournie, une valeur par défaut interne de [] (list) sera définie comme nouvelle valeur par défaut.

identifier str

Attribut d'identifiant du connecteur.

ids_file_name str

Nom du fichier dans lequel les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

db_key str

Nom de clé où les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

Renvoie

Liste d'ID dans l'objet DataStream.

Type renvoyé

list

TIPCommon.smp_io.read_content

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

Lire le contenu d'un objet ConnectorStream. Si l'objet ne contient aucune donnée ou n'existe pas, renvoyez une valeur par défaut.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

file_name str

Nom du fichier à valider (lorsque la plate-forme utilise des fichiers).

db_key str

Nom de la clé à valider (lorsque la plate-forme utilise une base de données).

default_value_to_return dict/list/str

Valeur par défaut définie lors de la création d'un fichier et d'une clé. Si aucune valeur n'est fournie, une valeur par défaut interne de {} (dict) est définie comme nouvelle valeur par défaut.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

(dict) : contenu de l'objet DataStream. Le contenu transite par json.loads avant d'être renvoyé.

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

Lit les ID d'un objet ConnectorStream. Si l'objet ne contient aucune donnée ou n'existe pas, renvoyez une valeur par défaut.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

ids_file_name sttr

Nom du fichier dans lequel les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

db_key str

Nom de clé où les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

default_value_to_return dict/list/str

Valeur par défaut à définir en cas de création d'un fichier et d'une clé. Si aucune valeur n'est fournie, une valeur par défaut interne [] (list) est définie comme nouvelle valeur par défaut.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

(list) Liste d'ID dans l'objet DataStream. Le contenu transite par json.loads avant d'être renvoyé.

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

Lit les ID d'un objet ConnectorStream. Si l'objet ne contient aucune donnée ou n'existe pas, renvoyez une valeur par défaut.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

offset_in_hours int

Délai (valeur de décalage) de l'ID en heures.

convert_to_milliseconds bool

Transformez le code temporel (Unix) de chaque ID de secondes en millisecondes.

cast_keys_to_integers bool

Castez les clés en nombres entiers.

offset_is_in_days bool

Si le décalage fourni à cette méthode est en jours, définissez le paramètre sur True pour convertir les jours de décalage en heures.

ids_file_name str

Nom du fichier dans lequel les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

db_key str

Nom de clé où les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

default_value_to_return dict/list/str

Valeur par défaut à définir en cas de création d'un fichier et d'une clé.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

(list) Liste d'ID dans l'objet DataStream. Le contenu transite par json.loads avant d'être renvoyé.

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)

Écrit du contenu dans un objet ConnectorStream.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

content_to_write dict/list/str

Contenu à écrire dans le flux de données dédié.

file_name str

Nom du fichier.

db_key str

Nom de la clé.

default_value_to_set dict/list/str

Valeur par défaut définie lors de la création d'un fichier et d'une clé.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

Aucun

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

Écrit les 1 000 derniers ID dans un objet ConnectorStream.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

ids list/str

ID à écrire dans le flux de données dédié.

stored_ids_limit int

Nombre d'ID récents parmi les ID existants qui seront écrits.

ids_file_name str

Nom du fichier dans lequel les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

db_key str

Nom de clé où les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

default_value_to_set dict/list/str

Valeur par défaut définie lors de la création d'un fichier et d'une clé.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

Aucun

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

Écrit des ID dans un objet ConnectorStream avec un code temporel.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

ids list/str

ID à écrire dans le flux de données dédié.

ids_file_name str

Nom du fichier dans lequel les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

db_key str

Nom de clé où les ID doivent être enregistrés lorsqu'un objet FileStream a été créé.

default_value_to_set dict/list/str

Valeur par défaut à définir en cas de création d'un fichier et d'une clé.

identifier str

Attribut d'identifiant du connecteur.

Renvoie

Aucun

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.