מודול data_models

המודול הזה מכיל מחלקות נתונים לייצוג של הפריטים הבאים:

  • מודלים של נתונים
  • התראות
  • מאגרי משתנים
  • פרמטרים כלליים
  • פרמטרים של מחברים

class TIPCommon.data_models.AlertCard

class TIPCommon.data_models.AlertCard(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, identifier: str, status: int, name: str, priority: int, workflow_status: int, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, start_time: int, end_time: int, alert_group_identifier: str, events_count: int, title: str, rule_generator: str, device_product: str, playbook_attached: str | None, playbook_run_count: int, is_manual_alert: bool, sla: SLA, fields_groups: list[FieldsGroup], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None)

בסיסים: object

כרטיס סיכום של התראה, שמכיל את הפרטים העיקריים והמטא-נתונים שלה.

classmethod from_json(alert_card_json: Dict[str, Any])→ AlertCard

יוצרת אובייקט AlertCard ממילון JSON שמייצג את המאפיינים שלו.

class TIPCommon.data_models.AlertEvent

class TIPCommon.data_models.AlertEvent(fields: list[EventPropertyField], identifier: str, case_id: int, alert_identifier: str, name: str, product: str, port: str | None, source_system_name: str, outcome: str | None, time: int, type_: str, artifact_entities: list[str])

בסיסים: object

מייצג אירוע יחיד שמשויך להתראה בתוך תיק.

classmethod from_json(event_json: MutableMapping[str, Any])→ AlertEvent

יוצרת אובייקט AlertEvent ממילון JSON.

‫class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את רמות העדיפות של התראה.

קבועים

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

‫class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

בסיסים: object

מייצג התראה בסיסית. יש לו את המאפיינים הבאים:

מאפיינים

raw_data הנתונים הגולמיים של ההתראה.
alert_id המזהה של ההתראה.

Methods

  • to_json()→ dict
דוגמה
>>> from data_models import BaseAlert
>>> alert = BaseAlert({'foo': 'bar'}, 100)
>>> alert.raw_data
{'foo': 'bar'}
>>> alert.alert_id
100
>>> alert.to_json()
{'foo': 'bar'}

‫class TIPCommon.data_models.BaseDataModel

class TIPCommon.data_models.BaseDataModel(raw_data)

בסיסים: object

מייצג מודל נתונים בסיסי.

מאפיינים

מאפיין תיאור
raw_data הנתונים הגולמיים של מודל הנתונים.

Methods

  • to_json()→ dict
דוגמה
>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.CaseDataStatus

class TIPCommon.data_models.CaseDataStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

קבועים

  • ALL = 3

  • CLOSED = 2

  • CREATION_PENDING = 5

  • MERGED = 4

  • NEW = 0

  • OPENED = 1

‫class TIPCommon.data_models.CaseDetails

class TIPCommon.data_models.CaseDetails(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, name: str, priority: int, is_important: bool, is_incident: bool, start_time_unix_time_ms: int, end_time_unix_time_ms: int, assigned_user: str, description: str | None, is_test_case: bool, type_: int, stage: str, environment: str, status: CaseDataStatus, incident_id: int | None, tags: list[str], alerts: list[AlertCard], is_overflow_case: bool, is_manual_case: bool, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, stage_sla_expiration_unix_time_ms: int | None, stage_sla__critical_expiration_unix_time_in_ms: int | None, can_open_incident: bool, sla:SLA, stage_sla: SLA)

בסיסים: object

classmethod from_json(case_details_json: Dict[str, Any])→ CaseDetails

יוצרת אובייקט CaseDetails ממילון JSON.

‫property is_closed

property is_closed: bool

מציין אם הנרתיק סגור.

‫property is_open

property is_open: bool

מציין אם הפנייה פתוחה.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את רמות העדיפות של התראה.

קבועים

  • CRITICAL = 100

  • HIGH = 80

  • INFORMATIVE = -1

  • LOW = 40

  • MEDIUM = 60

  • UNCHANGED = 0

class TIPCommon.data_models.CaseWallAttachment

class TIPCommon.data_models.CaseWallAttachment(name: 'str', file_type: 'str', base64_blob: 'str', is_important: 'bool', case_id: 'int | None' = None)

בסיסים: object

מייצג קובץ מצורף שיוסף לקיר של בקשת תמיכה.

מאפיינים

מאפיין תיאור סוג
base64_blob התוכן של הקובץ המצורף בקידוד Base64. str
case_id המזהה של הפנייה שאליה משויך הקובץ המצורף. int | None
file_type סוג הקובץ של הקובץ המצורף. str
is_important מציין אם הקובץ המצורף סומן כחשוב. bool
name השם של הקובץ המצורף. str

class TIPCommon.data_models.ConnectorCard

class TIPCommon.data_models.ConnectorCard(integration: str, display_name: str, identifier: str, is_enabled: bool, is_remote: bool, status: ConnectorConnectivityStatusEnum)

בסיסים: object

מייצג כרטיס סיכום של מופע של מחבר.

classmethod from_json(connector_card_json: MutableMapping[str, Any])→ ConnectorCard

יוצרת אובייקט ConnectorCard ממילון JSON.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את סטטוס הקישוריות של מתקן טעינה.

קבועים

  • LIVE = 0

  • NO_CONNECTIVITY = 1

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

קבועים

מייצג את הסוגים של פרמטרים של מחברים.

  • BOOLEAN = 0

  • DOMAIN = 7

  • EMAIL = 8

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • SCRIPT = 12

  • STRING = 2

  • URL = 6

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

בסיסים: פרמטר

מייצג פרמטר של מחבר.

מאפיינים

מאפיין תיאור
name שם הפרמטר.
value הערך של הפרמטר.
type סוג הפרמטר (בהתאם ל-ConnectorParamTypes).
mode מצב הפרמטר.
is_mandatory מגדירים אם הפרמטר הוא חובה.
דוגמה
>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
    'param_name': 'api_root',
    'type': ConnectorParamTypes.STRING,
    'param_value': 'http://foo.bar',
    'is_mandatory': True,
    'mode': 0
    })
>>> print(p)
ConnectorParameter(name='api_root', value='http://foo.bar', type=2, mode=0, is_mandatory=True)

class TIPCommon.data_models.Container

בסיסים: object

מייצג מאגר של משתנים.

דוגמה
>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1

class TIPCommon.data_models.CustomField

class TIPCommon.data_models.CustomField(id: 'int', display_name: 'str', description: 'str', type: 'str', scopes: 'list[CustomFieldScope]')

בסיסים: object

ייצוג של הגדרה של שדה בהתאמה אישית בפלטפורמה.

מאפיינים

מאפיין תיאור
description str

התיאור של השדה המותאם אישית.
display_name str

השם המוצג של השדה המותאם אישית.
id int

המזהה הייחודי של השדה המותאם אישית.
scopes list[CustomFieldScope]

ההיקפים (למשל: התראה, בקשת תמיכה) שבהם השדה המותאם אישית רלוונטי.
type str

סוג הנתונים של השדה המותאם אישית.

classmethod from_json(json_data: MutableMapping[str, Any])→ CustomField

יוצרת אובייקט CustomField ממילון JSON.

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את ההיקפים האפשריים שבהם אפשר להחיל שדה מותאם אישית.

קבועים

  • ALERTS = 'Alert'

  • CASE = 'Case'

Methods

  • ‫build_parent_path(identifier: int)→ str יוצר את נתיב ההורה של הערך בשדה המותאם אישית על סמך המזהה.

class TIPCommon.data_models.CustomFieldValue

class TIPCommon.data_models.CustomFieldValue(custom_field_id: 'int', values: 'list[str]', scope: 'CustomFieldScope', identifier: 'int')

בסיסים: object

ערך שמוגדר לשדה מותאם אישית ספציפי.

מאפיינים

מאפיין תיאור
custom_field_id int

המזהה של השדה המותאם אישית.
identifier int

המזהה של הישות (מקרה או התראה) שאליה שייך הערך.
scope CustomFieldScope

ההיקף (למשל, התראה, פנייה) שבו חל הערך של השדה המותאם אישית.
values list[str]

רשימת הערכים שהוגדרו לשדה המותאם אישית.

classmethod from_json(json_data: MutableMapping[str, Any])→ CustomFieldValue

יוצרת אובייקט CustomFieldValue ממילון JSON.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את סוגי ההקשרים של מסד הנתונים לאחסון נתונים.

קבועים

  • ALERT = 2

  • CASE = 1

  • CONNECTOR = 4

  • GLOBAL = 0

  • JOB = 3

class TIPCommon.data_models.EventPropertyField

class TIPCommon.data_models.EventPropertyField(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[FieldItem])

בסיסים: object

מייצג קבוצת שדות במאפיינים של אירוע.

classmethod from_json(event_property_field: MutableMapping[str, Any])→ EventPropertyField

יוצרת אובייקט EventPropertyField ממילון JSON.

class TIPCommon.data_models.FieldGroupItem

class TIPCommon.data_models.FieldGroupItem(original_name: str, name: str, value: str)

בסיסים: object

מייצג פריט יחיד של צמד מפתח/ערך בקבוצת השדות של אירוע.

classmethod from_json(field_group_json: MutableMapping[str, Any])→ FieldGroupItem

יוצרת אובייקט FieldGroupItem ממילון JSON.

class TIPCommon.data_models.FieldItem

class TIPCommon.data_models.FieldItem(original_name: str, name: str, value: str)

בסיסים: object

מייצג פריט יחיד בשדה, שמכיל את השם המקורי, השם המעוצב והערך שלו.

classmethod from_json(field_json: MutableMapping[str, Any])→ FieldItem

יוצרת אובייקט FieldItem ממילון JSON.

class TIPCommon.data_models.FieldsGroup

class TIPCommon.data_models.FieldsGroup(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[[FieldGroupItem]])

בסיסים: object

מייצג קבוצה של שדות בתוך מבנה נתונים גדול יותר, ומשמש לעיתים קרובות לתצוגה.

classmethod from_json(field_group_json: Dict[str, Any])→ FieldsGroup

יוצרת אובייקט FieldsGroup ממילון JSON.

class TIPCommon.data_models.GoogleServiceAccount

class TIPCommon.data_models.GoogleServiceAccount(account_type: str, project_id: str, private_key_id: str, private_key: str, client_email: str, client_id: str, auth_uri: str, token_uri: str, auth_provider_x509_url: str, client_x509_cert_url: str)

בסיסים: object

מייצג את המאפיינים של חשבון שירות של Google.

Methods

  • ‫to_dict()→ dict הופך את מודל הנתונים לסדרת נתונים (dict).

מחזירה

מילון JSON של חשבון שירות.

סוג הערך שמוחזר

dict

‫class TIPCommon.data_models.InstalledIntegrationInstance

class TIPCommon.data_models.InstalledIntegrationInstance(instance: MutableMapping[str, Any], identifier: str, integration_identifier: str, environment_identifier: str, instance_name: str)

בסיסים: object

מייצג מופע מותקן של שילוב בסביבה.

classmethod from_json(integration_env_json: MutableMapping[str, Any])→ InstalledIntegrationInstance

יוצר אובייקט InstalledIntegrationInstance ממילון JSON.

פרמטרים
פרמטרים
integration_env_json SingleJson

נתוני JSON שמכילים מידע על סביבת השילוב.
מחזירה

מופע של המחלקה שצוינה, שאותחל עם נתונים מ-raw_data.

סוג הערך שמוחזר

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

קבועים

  • BOOLEAN = 0

  • DOMAIN = 7

  • HOST = 5

  • INTEGER = 1

  • IP = 4

  • NULL = -1

  • PASSWORD = 3

  • STRING = 2

  • URL = 6

‫class TIPCommon.data_models.Parameter

class TIPCommon.data_models.Parameter(raw_param)

בסיסים: object

מחלקת אב שמייצגת פרמטר.

מאפיינים

מאפיין תיאור
raw_data הנתונים הגולמיים של הפרמטר.
דוגמה
>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})

class TIPCommon.data_models.SLA

class TIPCommon.data_models.SLA(sla_expiration_time: int | None, critical_expiration_time: int | None, expiration_status: int, remaining_time_since_last_pause: int | None)

בסיסים: object

מייצג את הפרטים של הסכם רמת שירות (SLA) לגבי מקרה או התראה.

classmethod from_json(sla_json: Dict[str, Any])→ SLA

יוצר אובייקט SLA ממילון JSON.

class TIPCommon.data_models.ScriptContext

class TIPCommon.data_models.ScriptContext(target_entities: 'str' = '', case_id: 'int | str | None' = None, alert_id: 'str' = '', environment: 'str' = '', workflow_id: 'str' = '', workflow_instance_id: 'str | None' = None, parameters: 'SingleJson' = <factory>, integration_identifier: 'str' = '', integration_instance: 'str' = '', action_definition_name: 'str' = '', original_requesting_user: 'str' = '', execution_deadline_unix_time_ms: 'int' = 0, async_polling_interval_in_sec: 'int' = 0, async_total_duration_deadline: 'int' = 0, script_timeout_deadline: 'int' = 0, default_result_value: 'str' = '', use_proxy_settings: 'bool' = False, max_json_result_size: 'int' = 15, vault_settings: 'SiemplifyVault | None' = None, environment_api_key: 'str | None' = None, unique_identifier: 'str' = '', job_api_key: 'str' = '', connector_context: 'ConnectorContext | None' = None)

בסיסים: object

מייצג את הקשר הביצועי של סקריפט או פעולה, ומספק גישה לפרמטרים ולנתונים שונים של זמן ריצה.

מאפיינים

מאפיין תיאור
action_definition_name str

השם של הגדרת הפעולה שמופעלת.

ברירת המחדל היא ''.
alert_id str

המזהה של ההתראה שמשויכת להרצה הנוכחית.

ברירת המחדל היא ''.
async_polling_interval_in_sec int

מרווח הזמן בין בדיקות אסינכרוניות בשניות.

ברירת המחדל היא 0.
async_total_duration_deadline int

הזמן הכולל שמוקצב לפעולות אסינכרוניות.

ברירת המחדל היא 0.
case_id int | str | None

מזהה הפנייה שמשויך להרצה הנוכחית.

ברירת המחדל היא None.
connector_context ConnectorContext | None

הקשר שספציפי להרצת המחבר.

ברירת המחדל היא None.
default_result_value str

ערך ברירת המחדל של התוצאה של הפעולה.

ברירת המחדל היא ''.
environment str

סביבת ההפעלה.

ברירת המחדל היא ''.
environment_api_key str | None

מפתח ה-API של הסביבה.

ברירת המחדל היא None.
execution_deadline_unix_time_ms int

חותמת הזמן של מערכת Unix (באפליקציות של אלפיות השנייה) שמציינת את המועד האחרון להפעלה.

ברירת המחדל היא 0.
integration_identifier str

המזהה של השילוב שבו נעשה שימוש.

ברירת המחדל היא ''.
integration_instance str

השם של מופע השילוב שנמצא בשימוש.

ברירת המחדל היא ''.
job_api_key str

מפתח API ספציפי למשימה.

ברירת המחדל היא ''.
max_json_result_size int

הגודל המקסימלי המותר לתוצאות בפורמט JSON.

ברירת המחדל היא 15.
original_requesting_user str

המשתמש שיזם את הבקשה.

ברירת המחדל היא ''.
parameters SingleJson

אובייקט JSON שמכיל את הפרמטרים של הסקריפט או הפעולה.
script_timeout_deadline int

המועד האחרון להפסקת ביצוע הסקריפט בגלל חריגה מזמן קצוב לתפוגה.

ברירת המחדל היא 0.
target_entities str

מחרוזת של ישויות יעד מופרדות בפסיקים.

ברירת המחדל היא ''.
unique_identifier str

מזהה ייחודי של הקשר הביצועי.

ברירת המחדל היא ''.
use_proxy_settings bool

מציין אם צריך להשתמש בהגדרות לשרת proxy.

ברירת המחדל היא False.
vault_settings SiemplifyVault | None

הגדרות של Vault לאחזור מאובטח של פרטי כניסה.

ברירת המחדל היא None.
workflow_id str

המזהה של תהליך העבודה.

ברירת המחדל היא ''.
workflow_instance_id str | None

המזהה של מופע תהליך העבודה.

ברירת המחדל היא None.

Methods

  • to_json()→ MutableMapping[str, Any] הופך את אובייקט ההקשר למיפוי שניתן לשינוי (מילון JSON).

  • update(attributes: MutableMapping[str, Any])→ None מעדכן את אובייקט ההקשר עם מאפיינים חדשים ממיפוי שניתן לשינוי.

class TIPCommon.data_models.SmimeEmailConfig

class TIPCommon.data_models.SmimeEmailConfig(email: 'email.message.Message', private_key_b64: 'str', certificate_b64: 'str', ca_certificate_b64: 'str')

בסיסים: object

מייצג את ההגדרה לשליחת אימיילים מוצפנים או חתומים באמצעות S/MIME.

מאפיינים

מאפיין תיאור
ca_certificate_b64 str

אישור CA בקידוד base64.
certificate_b64 str

האישור בקידוד Base64.
email Message

אובייקט של הודעת אימייל.
private_key_b64 str

המפתח הפרטי בקידוד Base64.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Enum

מייצג את הסוגים של פעולות S/MIME.

קבועים

  • ENCRYPTED = 'encrypted'

  • SIGNED = 'signed'

‫class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

בסיסים: Generic[T]

מאגר לסוג ספציפי שמספק השלמה אוטומטית של סוגים.

class TIPCommon.data_models.UserProfileCard

class TIPCommon.data_models.UserProfileCard(raw_data: dict, first_name: str, last_name: str, user_name: str, account_state: int)

בסיסים: object

מייצג כרטיס סיכום של פרופיל משתמש.

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

יוצרת אובייקט UserProfileCard ממילון JSON.

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.