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,並在 ID 為字典時轉換為清單。這是避免回歸的必要做法。
參數
參數 | |
---|---|
siemplify |
SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob Google Security Operations SOAR SDK 的執行個體。 |
default_value_to_return |
dict | list | string 建立新檔案或金鑰時要設定的預設值。如未提供值,系統會將內部預設值 |
identifier |
str 連接器的 ID 屬性。 |
ids_file_name |
str 建立 |
db_key |
str 建立 |
傳回
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 |
file_name |
str 要驗證的檔案名稱 (平台使用檔案時)。 |
db_key |
str 要驗證的金鑰名稱 (平台使用資料庫時)。 |
default_value_to_return |
dict/list/str 建立新檔案和金鑰時設定的預設值。如未提供值,系統會將內部預設值 |
identifier |
str 連接器的 ID 屬性。 |
傳回
(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 |
ids_file_name |
sttr 建立 |
db_key |
str 建立 |
default_value_to_return |
dict/list/str 建立新檔案和金鑰時要設定的預設值。如未提供值,系統會將內部預設值 |
identifier |
str 連接器的 ID 屬性。 |
傳回
(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 |
offset_in_hours |
int ID 的時間限制 (偏移值),以小時為單位。 |
convert_to_milliseconds |
bool 將每個 ID 的時間戳記 (Unix) 從秒轉換為毫秒。 |
cast_keys_to_integers |
bool 將鍵轉換為整數。 |
offset_is_in_days |
bool 如果提供給這個方法的時差是以天為單位,請將參數設為 |
ids_file_name |
str 建立 |
db_key |
str 建立 |
default_value_to_return |
dict/list/str 建立新檔案和金鑰時要設定的預設值。 |
identifier |
str 連接器的 ID 屬性。 |
傳回
(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 |
content_to_write |
dict/list/str 要寫入專屬資料串流的內容。 |
file_name |
str 檔案名稱。 |
db_key |
str 金鑰名稱。 |
default_value_to_set |
dict/list/str 建立新檔案和金鑰時設定的預設值。 |
identifier |
str 連接器的 ID 屬性。 |
傳回
無
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 |
ids |
list/str 要寫入專屬資料串流的 ID。 |
stored_ids_limit |
int 要寫入的現有 ID 中,最近的 ID 數量。 |
ids_file_name |
str 建立 |
db_key |
str 建立 |
default_value_to_set |
dict/list/str 建立新檔案和金鑰時設定的預設值。 |
identifier |
str 連接器的 ID 屬性。 |
傳回
無
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 |
ids |
list/str 要寫入專屬資料串流的 ID。 |
ids_file_name |
str 建立 |
db_key |
str 建立 |
default_value_to_set |
dict/list/str 建立新檔案和金鑰時要設定的預設值。 |
identifier |
str 連接器的 ID 屬性。 |
傳回
無
還有其他問題嗎?向社群成員和 Google SecOps 專業人員尋求答案。