Modul data_models

Modul ini berisi class data untuk merepresentasikan hal berikut:

  • Model data
  • Notifikasi
  • Penampung variabel
  • Parameter umum
  • Parameter konektor

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)

Dasar: object

Mewakili kartu ringkasan pemberitahuan, yang berisi detail dan metadata utamanya.

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

Membuat objek AlertCard dari kamus JSON yang merepresentasikan atributnya.

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

Dasar: object

Mewakili satu peristiwa yang terkait dengan pemberitahuan dalam kasus.

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

Membuat objek AlertEvent dari kamus JSON.

class TIPCommon.data_models.AlertPriority

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

Dasar: Enum

Mewakili tingkat prioritas untuk pemberitahuan.

Konstanta

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

Dasar: object

Mewakili pemberitahuan dasar. Objek ini memiliki properti berikut:

Atribut

raw_data Data mentah untuk pemberitahuan.
alert_id ID pemberitahuan.

Metode

  • to_json()→ dict
Contoh
>>> 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)

Dasar: object

Mewakili model data dasar.

Atribut

Atribut Deskripsi
raw_data Data mentah untuk model data.

Metode

  • to_json()→ dict
Contoh
>>> 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)

Dasar: Enum

Konstanta

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

Dasar: object

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

Membuat objek CaseDetails dari kamus JSON.

property is_closed

properti is_closed: bool

Menunjukkan apakah kasus ditutup.

property is_open

properti is_open: bool

Menunjukkan apakah kasus terbuka.

class TIPCommon.data_models.CasePriority

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

Dasar: Enum

Mewakili tingkat prioritas untuk pemberitahuan.

Konstanta

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

Dasar: object

Mewakili lampiran yang akan ditambahkan ke repositori kasus.

Atribut

Atribut Deskripsi Jenis
base64_blob Konten lampiran berenkode base64. str
case_id ID kasus tempat lampiran berada. int | None
file_type Jenis file lampiran. str
is_important Menunjukkan apakah lampiran ditandai sebagai penting. bool
name Nama file lampiran. 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)

Dasar: object

Merepresentasikan kartu ringkasan untuk instance konektor.

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

Membuat objek ConnectorCard dari kamus JSON.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

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

Dasar: Enum

Mewakili status konektivitas konektor.

Konstanta

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

Dasar: Enum

Konstanta

Mewakili jenis parameter konektor.

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

Dasar: Parameter

Mewakili parameter konektor.

Atribut

Atribut Deskripsi
name Nama parameter.
value Nilai parameter.
type Jenis parameter (sesuai dengan ConnectorParamTypes).
mode Mode parameter.
is_mandatory Tentukan apakah parameter wajib diisi.
Contoh
>>> 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

Dasar: object

Mewakili penampung untuk variabel.

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

Dasar: object

Mewakili definisi kolom kustom dalam platform.

Atribut

Atribut Deskripsi
description str

Deskripsi kolom kustom.
display_name str

Nama tampilan kolom kustom.
id int

ID unik kolom kustom.
scopes list[CustomFieldScope]

Cakupan (misalnya, Pemberitahuan, Kasus) tempat kolom kustom berlaku.
type str

Jenis data kolom kustom.

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

Membuat objek CustomField dari kamus JSON.

class TIPCommon.data_models.CustomFieldScope

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

Dasar: Enum

Menunjukkan kemungkinan cakupan tempat kolom kustom dapat diterapkan.

Konstanta

  • ALERTS = 'Alert'

  • CASE = 'Case'

Metode

  • build_parent_path(identifier: int)→ str Membangun jalur induk untuk nilai kolom kustom berdasarkan ID.

class TIPCommon.data_models.CustomFieldValue

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

Dasar: object

Merepresentasikan nilai yang ditetapkan untuk kolom kustom tertentu.

Atribut

Atribut Deskripsi
custom_field_id int

ID kolom kustom.
identifier int

ID entitas (kasus/pemberitahuan) yang memiliki nilai.
scope CustomFieldScope

Cakupan (misalnya, Peringatan, Kasus) tempat nilai kolom kustom berlaku.
values list[str]

Daftar nilai yang ditetapkan untuk kolom kustom.

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

Membuat objek CustomFieldValue dari kamus JSON.

class TIPCommon.data_models.DatabaseContextType

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

Dasar: Enum

Mewakili jenis konteks database untuk penyimpanan data.

Konstanta

  • 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])

Dasar: object

Mewakili grup kolom dalam properti acara.

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

Membuat objek EventPropertyField dari kamus JSON.

class TIPCommon.data_models.FieldGroupItem

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

Dasar: object

Menampilkan satu item key-value dalam grup kolom peristiwa.

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

Membuat objek FieldGroupItem dari kamus JSON.

class TIPCommon.data_models.FieldItem

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

Dasar: object

Mewakili satu item dalam kolom, yang berisi nama asli, nama yang diformat, dan nilainya.

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

Membuat objek FieldItem dari kamus 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]])

Dasar: object

Mewakili sekelompok kolom dalam struktur data yang lebih besar, sering digunakan untuk tampilan.

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

Membuat objek FieldsGroup dari kamus 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)

Dasar: object

Merepresentasikan atribut Akun Layanan Google.

Metode

  • to_dict()→ dict Menserialisasi model data ke dalam dict.

Hasil

Dict JSON Akun Layanan.

Jenis hasil yang ditampilkan

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)

Dasar: object

Mewakili instance integrasi yang diinstal dalam lingkungan.

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

Membuat objek InstalledIntegrationInstance dari kamus JSON.

Parameter
Parameter
integration_env_json SingleJson

Data JSON yang berisi informasi lingkungan integrasi.
Hasil

Instance class yang ditentukan diinisialisasi dengan data dari raw_data.

Jenis hasil yang ditampilkan

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

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

Dasar: Enum

Konstanta

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

Dasar: object

Class induk yang merepresentasikan parameter.

Atribut

Atribut Deskripsi
raw_data Data mentah untuk parameter.
Contoh
>>> 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)

Dasar: object

Mewakili detail Perjanjian Tingkat Layanan (SLA) untuk kasus atau pemberitahuan.

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

Membuat objek SLA dari kamus 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)

Dasar: object

Mewakili konteks eksekusi untuk skrip atau tindakan, yang memberikan akses ke berbagai parameter dan data runtime.

Atribut

Atribut Deskripsi
action_definition_name str

Nama definisi tindakan yang sedang dieksekusi.

Nilai defaultnya adalah ''.
alert_id str

ID pemberitahuan yang terkait dengan eksekusi saat ini.

Nilai defaultnya adalah ''.
async_polling_interval_in_sec int

Interval untuk polling asinkron dalam detik.

Nilai defaultnya adalah 0.
async_total_duration_deadline int

Batas waktu durasi total untuk operasi asinkron.

Nilai defaultnya adalah 0.
case_id int | str | None

ID kasus yang terkait dengan eksekusi saat ini.

Nilai defaultnya adalah None.
connector_context ConnectorContext | None

Konteks khusus untuk eksekusi konektor.

Nilai defaultnya adalah None.
default_result_value str

Nilai default untuk hasil tindakan.

Nilai defaultnya adalah ''.
environment str

Lingkungan eksekusi.

Nilai defaultnya adalah ''.
environment_api_key str | None

Kunci API untuk lingkungan.

Nilai defaultnya adalah None.
execution_deadline_unix_time_ms int

Stempel waktu Unix (dalam milidetik) yang menunjukkan batas waktu eksekusi.

Nilai defaultnya adalah 0.
integration_identifier str

ID integrasi yang sedang digunakan.

Nilai defaultnya adalah ''.
integration_instance str

Nama instance integrasi yang digunakan.

Nilai defaultnya adalah ''.
job_api_key str

Kunci API khusus untuk tugas.

Nilai defaultnya adalah ''.
max_json_result_size int

Ukuran maksimum yang diizinkan untuk hasil JSON.

Nilai defaultnya adalah 15.
original_requesting_user str

Pengguna yang awalnya memulai permintaan.

Nilai defaultnya adalah ''.
parameters SingleJson

Objek JSON yang berisi parameter untuk skrip/tindakan.
script_timeout_deadline int

Batas waktu untuk waktu tunggu habis eksekusi skrip.

Nilai defaultnya adalah 0.
target_entities str

String entitas target yang dipisahkan koma.

Nilai defaultnya adalah ''.
unique_identifier str

ID unik untuk konteks eksekusi.

Nilai defaultnya adalah ''.
use_proxy_settings bool

Menunjukkan apakah setelan proxy harus digunakan.

Nilai defaultnya adalah False.
vault_settings SiemplifyVault | None

Setelan Vault untuk pengambilan kredensial yang aman.

Nilai defaultnya adalah None.
workflow_id str

ID alur kerja.

Nilai defaultnya adalah ''.
workflow_instance_id str | None

ID instance alur kerja.

Nilai defaultnya adalah None.

Metode

  • to_json()→ MutableMapping[str, Any] Menserialisasi objek konteks ke dalam pemetaan yang dapat diubah (kamus JSON).

  • update(attributes: MutableMapping[str, Any])→ None Memperbarui objek konteks dengan atribut baru dari pemetaan yang dapat diubah.

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

Dasar: object

Mewakili konfigurasi untuk mengirim email yang dienkripsi atau ditandatangani S/MIME.

Atribut

Atribut Deskripsi
ca_certificate_b64 str

Sertifikat CA yang dienkode base64.
certificate_b64 str

Sertifikat berenkode base64.
email Message

Objek pesan email.
private_key_b64 str

Kunci pribadi berenkode base64.

class TIPCommon.data_models.SmimeType

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

Dasar: Enum

Mewakili jenis operasi S/MIME.

Konstanta

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

Basis: Generic[T]

Penampung untuk jenis tertentu yang menyediakan intellisense jenis.

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)

Dasar: object

Menampilkan kartu ringkasan profil pengguna.

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

Membuat objek UserProfileCard dari kamus JSON.

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.