data_models モジュール

このモジュールには、次のものを表すデータクラスが含まれています。

  • データモデル
  • アラート
  • 変数コンテナ
  • 一般的なパラメータ
  • コネクタ パラメータ

class TIPCommon.data_models.AlertCard

クラス 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)

ベース: オブジェクト

アラートの概要カードを表します。アラートの主な詳細とメタデータが含まれます。

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

属性を表す JSON 辞書から AlertCard オブジェクトを作成します。

class TIPCommon.data_models.AlertEvent

クラス 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])

ベース: オブジェクト

ケース内のアラートに関連付けられた単一のイベントを表します。

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

JSON 辞書から AlertEvent オブジェクトを作成します。

class TIPCommon.data_models.AlertPriority

クラス 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

クラス TIPCommon.data_models.BaseAlert(raw_data, alert_id)

ベース: オブジェクト

基本アラートを表します。これには次のプロパティがあります。

属性

raw_data アラートの元データ。
alert_id アラートの ID。

メソッド

  • 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

クラス TIPCommon.data_models.BaseDataModel(raw_data)

ベース: オブジェクト

ベースデータモデルを表します。

属性

属性 説明
raw_data データモデルの元データ。

メソッド

  • 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

クラス 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

クラス 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)

ベース: オブジェクト

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

JSON 辞書から CaseDetails オブジェクトを作成します。

property is_closed

プロパティ is_closed: bool

ケースがクローズされているかどうかを示します。

プロパティ is_open

プロパティ is_open: bool

ケースがオープンかどうかを示します。

class TIPCommon.data_models.CasePriority

クラス 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

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

ベース: オブジェクト

ケースウォールに追加される添付ファイルを表します。

属性

属性 説明 タイプ
base64_blob 添付ファイルの Base64 エンコードされたコンテンツ。 str
case_id 添付ファイルが属するケースの ID。 int | None
file_type 添付ファイルのファイル形式。 str
is_important 添付ファイルに重要マークが付いているかどうかを示します。 bool
name 添付ファイルの名前。 str

class TIPCommon.data_models.ConnectorCard

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

ベース: オブジェクト

コネクタ インスタンスの概要カードを表します。

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

JSON 辞書から ConnectorCard オブジェクトを作成します。

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

クラス 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

クラス 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

クラス 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

ベース: オブジェクト

変数のコンテナを表します。

例
>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1

class TIPCommon.data_models.CustomField

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

ベース: オブジェクト

プラットフォーム内のカスタム フィールドの定義を表します。

属性

属性 説明
description str

カスタム フィールドの説明。
display_name str

カスタム フィールドの表示名。
id int

カスタム フィールドの一意の ID。
scopes list[CustomFieldScope]

スコープ（カスタム項目が適用される（Alert、Case）
type str

カスタム フィールドのデータ型。

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

JSON 辞書から CustomField オブジェクトを作成します。

class TIPCommon.data_models.CustomFieldScope

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

ベース: Enum

カスタム フィールドを適用できるスコープを表します。

定数

  • ALERTS = 'Alert'

  • CASE = 'Case'

メソッド

  • build_parent_path(identifier: int)→ str 識別子に基づいてカスタム フィールド値の親パスを構築します。

class TIPCommon.data_models.CustomFieldValue

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

ベース: オブジェクト

特定のカスタム フィールドに設定された値を表します。

属性

属性 説明
custom_field_id int

カスタム フィールドの ID。
identifier int

値が属するエンティティ（ケース/アラート）の ID。
scope CustomFieldScope

スコープ（例: カスタム項目の値が適用されるオブジェクト（Alert、Case）。
values list[str]

カスタム フィールドに設定された値のリスト。

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

JSON 辞書から CustomFieldValue オブジェクトを作成します。

class TIPCommon.data_models.DatabaseContextType

クラス 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

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

ベース: オブジェクト

イベントのプロパティ内のフィールド グループを表します。

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

JSON 辞書から EventPropertyField オブジェクトを作成します。

class TIPCommon.data_models.FieldGroupItem

クラス TIPCommon.data_models.FieldGroupItem(original_name: str, name: str, value: str)

ベース: オブジェクト

イベントのフィールド グループ内の単一の Key-Value アイテムを表します。

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

JSON 辞書から FieldGroupItem オブジェクトを作成します。

class TIPCommon.data_models.FieldItem

クラス TIPCommon.data_models.FieldItem(original_name: str, name: str, value: str)

ベース: オブジェクト

フィールド内の単一の項目を表します。元の名前、フォーマットされた名前、値が含まれます。

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

JSON 辞書から FieldItem オブジェクトを作成します。

class TIPCommon.data_models.FieldsGroup

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

ベース: オブジェクト

より大きなデータ構造内のフィールドのグループを表します。多くの場合、表示に使用されます。

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

JSON 辞書から FieldsGroup オブジェクトを作成します。

class TIPCommon.data_models.GoogleServiceAccount

クラス 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)

ベース: オブジェクト

Google サービス アカウントの属性を表します。

メソッド

  • to_dict()→ dict データモデルを dict にシリアル化します。

戻り値

サービス アカウントの JSON 辞書。

戻り値の型

dict

class TIPCommon.data_models.InstalledIntegrationInstance

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

ベース: オブジェクト

環境内の統合のインストール済みインスタンスを表します。

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

JSON 辞書から InstalledIntegrationInstance オブジェクトを作成します。

パラメータ
パラメータ
integration_env_json SingleJson

統合環境情報を含む JSON データ。
戻り値

raw_data のデータで初期化された、指定されたクラスのインスタンス。

戻り値の型

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

クラス 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

クラス TIPCommon.data_models.Parameter(raw_param)

ベース: オブジェクト

パラメータを表す親クラス。

属性

属性 説明
raw_data パラメータの生データ。
例
>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})

class TIPCommon.data_models.SLA

クラス TIPCommon.data_models.SLA(sla_expiration_time: int | None, critical_expiration_time: int | None, expiration_status: int, remaining_time_since_last_pause: int | None)

ベース: オブジェクト

ケースまたはアラートのサービスレベル契約（SLA）の詳細を表します。

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

JSON 辞書から SLA オブジェクトを作成します。

class TIPCommon.data_models.ScriptContext

クラス 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)

ベース: オブジェクト

スクリプトまたはアクションの実行コンテキストを表し、さまざまなランタイム パラメータとデータへのアクセスを提供します。

属性

属性 説明
action_definition_name str

実行されるアクション定義の名前。

デフォルトは '' です。
alert_id str

現在の実行に関連付けられたアラートの ID。

デフォルトは '' です。
async_polling_interval_in_sec int

非同期ポーリングの間隔（秒単位）。

デフォルトは 0 です。
async_total_duration_deadline int

非同期オペレーションの合計期間の期限。

デフォルトは 0 です。
case_id int | str | None

現在の実行に関連付けられたケースの ID。

デフォルトは 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

プロキシ設定を使用するかどうかを示します。

デフォルトは False です。
vault_settings SiemplifyVault | None

安全な認証情報の取得のための Vault の設定。

デフォルトは None です。
workflow_id str

ワークフローの ID。

デフォルトは '' です。
workflow_instance_id str | None

ワークフロー インスタンスの ID。

デフォルトは None です。

メソッド

  • to_json()→ MutableMapping[str, Any] コンテキスト オブジェクトを可変マッピング（JSON 辞書）にシリアル化します。

  • update(attributes: MutableMapping[str, Any])→ None ミュータブル マッピングの新しい属性でコンテキスト オブジェクトを更新します。

class TIPCommon.data_models.SmimeEmailConfig

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

ベース: オブジェクト

S/MIME で暗号化または署名されたメールを送信するための構成を表します。

属性

属性 説明
ca_certificate_b64 str

base64 でエンコードされた CA 証明書。
certificate_b64 str

base64 でエンコードされた証明書。
email Message

メール メッセージ オブジェクト。
private_key_b64 str

Base64 でエンコードされた秘密鍵。

class TIPCommon.data_models.SmimeType

クラス 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

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

ベース: Generic[T]

型インテリセンスを提供する特定の型のコンテナ。

class TIPCommon.data_models.UserProfileCard

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

ベース: オブジェクト

ユーザー プロフィール サマリーカードを表します。

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

JSON 辞書から UserProfileCard オブジェクトを作成します。

さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。