此页面由 Cloud Translation API 翻译。

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

读取现有提醒 ID，如果它们是字典，则将其转换为列表。这是避免出现回归所必需的。

参数

参数
`siemplify`	`SiemplifyAction \| SiemplifyConnectorExecution \| SiemplifyJob` Google Security Operations SOAR SDK 的实例。
`default_value_to_return`	`dict \| list \| string` 创建新文件或密钥时要设置的默认值。如果未提供任何值，则系统会将内部默认值 `[]` (`list`) 设置为新的默认值。
`identifier`	`str` 连接器的标识符属性。
`ids_file_name`	`str` 创建 `FileStream` 对象时应保存 ID 的文件名。
`db_key`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的键名。

返回值

DataStream 对象中的 ID 列表。

返回类型

list

TIPCommon.smp_io.read_content

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

读取 ConnectorStream 对象的内容。如果对象不包含任何数据或不存在，则返回默认值。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`file_name`	`str` 要验证的文件的名称（当平台使用文件时）。
`db_key`	`str` 要验证的密钥的名称（当平台使用数据库时）。
`default_value_to_return`	`dict/list/str` 创建新文件和密钥时设置的默认值。如果未提供任何值，则将内部默认值 `{} (dict)` 设置为新的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

(dict) DataStream 对象中的内容。内容在返回之前会先通过 json.loads。

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

从 ConnectorStream 对象读取 ID。如果对象不包含任何数据或不存在，则返回默认值。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`ids_file_name`	`sttr` 创建 `FileStream` 对象后，应将 ID 保存到的文件名。
`db_key`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的键名。
`default_value_to_return`	`dict/list/str` 在创建新文件和密钥时要设置的默认值。如果未提供任何值，则将内部默认值 `[] (list)` 设置为新的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

(list) DataStream 对象中的 ID 列表。内容在返回之前会先通过 json.loads。

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

从 ConnectorStream 对象读取 ID。如果对象不包含任何数据或不存在，则返回默认值。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`offset_in_hours`	`int` 相应 ID 的时限（偏移值），以小时为单位。
`convert_to_milliseconds`	`bool` 将每个 ID 的时间戳（Unix）从秒转换为毫秒。
`cast_keys_to_integers`	`bool` 将键转换为整数。
`offset_is_in_days`	`bool` 如果提供给此方法的偏移量以天为单位，请将该参数设置为 `True`，以便将偏移天数转换为小时数。
`ids_file_name`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的文件名。
`db_key`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的键名。
`default_value_to_return`	`dict/list/str` 在创建新文件和密钥时要设置的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

(list) DataStream 对象中的 ID 列表。内容在返回之前会先通过 json.loads。

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)

将内容写入 ConnectorStream 对象。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`content_to_write`	`dict/list/str` 要写入专用数据流的内容。
`file_name`	`str` 文件的名称。
`db_key`	`str` 密钥的名称。
`default_value_to_set`	`dict/list/str` 创建新文件和密钥时设置的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

无。

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

将最后 1000 个 ID 写入 ConnectorStream 对象。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`ids`	`list/str` 要写入专用数据流的 ID。
`stored_ids_limit`	`int` 将写入的现有 ID 中的近期 ID 数量。
`ids_file_name`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的文件名。
`db_key`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的键名。
`default_value_to_set`	`dict/list/str` 创建新文件和密钥时设置的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

无。

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

将 ID 写入带有时间戳的 ConnectorStream 对象。

参数
`siemplify`	`obj` SDK `SiemplifyConnectorExecution` 类的实例。
`ids`	`list/str` 要写入专用数据流的 ID。
`ids_file_name`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的文件名。
`db_key`	`str` 创建 `FileStream` 对象后，应将 ID 保存到的键名。
`default_value_to_set`	`dict/list/str` 在创建新文件和密钥时要设置的默认值。
`identifier`	`str` 连接器的标识符属性。

返回值

无。