TIPCommon.base
Das Modul TIPCommon.base dient als grundlegende technische Referenz für die Integrationsentwicklung in Google SecOps und bietet die Kernlogik für Aktionen, Hintergrundjobs und plattformübergreifende Datennormalisierung.
Aktionsdaten parsen
Dieser Abschnitt enthält Dienstfunktionen, die erforderlich sind, um Falldaten aus API-Rohantworten in strukturierte Objekte für die Verwendung in Automatisierungsaufgaben zu parsen.
TIPCommon.base.action.action_parser.parse_case_attachment
TIPCommon.base.action.action_parser.parse_case_attachment(attachment: MutableMapping[str, Any]) → CaseAttachment
Dieses Dienstprogramm wandelt rohe JSON-Anhangsdaten aus einer API-Antwort in ein strukturiertes CaseAttachment-Objekt um.
Parameter
| Parameter | |
|---|---|
attachment |
Die JSON-Rohdaten des Anhangs, wie sie aus der API-Antwort abgerufen wurden. |
TIPCommon.base.action.action_parser.parse_case_comment
TIPCommon.base.action.action_parser.parse_case_comment(comment: MutableMapping[str, Any]) → CaseComment
Diese Funktion parst rohe JSON-Kommentardaten in ein CaseComment-Objekt, um den Zugriff auf Kommentar-Metadaten zu erleichtern.
Parameter
| Parameter | |
|---|---|
comment |
Die JSON-Rohdaten des Kommentars, die aus der API-Antwort abgerufen wurden. |
class TIPCommon.base.action.base_action.Action
class TIPCommon.base.action.base_action.Action(name: str)
Basen: ABC, Generic[ApiClient]
Die Basisklasse Action bietet eine einheitliche Infrastruktur für die Entwicklung von Automatisierungen, einschließlich der Verwaltung von Attributen und allgemeinen Ausführungsabläufen.
Parameter
| Parameter | |
|---|---|
name |
Die Kennung für das Aktionsscript. |
Attribute
Mit den folgenden Attributen wird der interne Status der Aktion verwaltet und Zugriff auf SDK-Ressourcen und Integrationsclients gewährt.
| Attribute | |
|---|---|
_soar_action |
Das |
_api_client |
Der API-Client der Integration. |
_name |
Der Name des Scripts, das diese Aktion verwendet. |
_action_start_time |
Die Startzeit der Aktion in Unix. |
_logger |
Das Logger-Objekt, das für das Logging in Aktionen verwendet wird. |
_params |
Der Parametercontainer für diese Aktion. |
global_context |
Ein Wörterbuch zum Speichern des Kontexts, falls erforderlich. |
_entity_types |
Die von der Aktion unterstützten Entitätstypen. |
_entities_to_update |
Die Entitäten, die aktualisiert werden sollen, wenn die Aktion endet. |
json_results |
Die JSON-Ergebnisse der Aktion. |
_attachments |
Die Anhänge des Fallergebnisses, die hinzugefügt werden sollen. |
_contents |
Der Inhalt des Fallergebnisses, der hinzugefügt werden soll. |
_data_tables |
Die Datentabellen mit den Fallergebnissen, die hinzugefügt werden sollen. |
_html_reports |
Die HTML-Berichte zu den Fallergebnissen, die hinzugefügt werden sollen. |
_links |
Die Links zu den Fallergebnissen, die hinzugefügt werden sollen. |
_markdowns |
Die Markdowns für Fallergebnisse, die hinzugefügt werden sollen. |
_entity_insights |
Die Fallentitätsstatistiken, die hinzugefügt werden sollen. |
_case_insights |
Die Fallstatistiken, die hinzugefügt werden sollen. |
_execution_state |
Die Anzeige des endgültigen Ausführungsstatus der Aktion. |
_result_value |
Der endgültige Ergebniswert der Aktion. |
_output_message |
Die Ausgabemeldung der Aktion, wenn sie erfolgreich ist. |
_error_output_message |
Die Ausgabenachricht der Aktion, wenn sie fehlschlägt. |
Methoden
Standardmethoden zum Verwalten des Lebenszyklus und der Ausgabeformatierung eines Aktionsskripts.
- run() |
Führt die Aktion aus. |
- _get_adjusted_json_results() |
Passt das JSON-Ergebnis an eine bestimmte Struktur an. |
Abstrakte Methoden
Entwickler müssen diese Methoden überschreiben, um die eindeutige Logik für eine benutzerdefinierte Aktion zu definieren.
| Abstrakte Methoden | |
|---|---|
_validate_params() |
Validiert die Parameter für diese Aktion. |
_init_api_clients() |
Initialisiert die API-Clients der Aktion. |
_perform_action() |
Führt die Hauptlogik der Aktion aus. |
Zusätzliche Methoden
Diese optionalen Methoden werden in bestimmten Phasen des Lebenszyklus der Aktionsausführung ausgelöst, um Benachrichtigungen zu verarbeiten oder Ressourcen zu bereinigen.
_get_entity_types()_finalize_action_on_success()_finalize_action_on_failure()_on_entity_failure()_handle_timeout()_extract_action_parameters()_finalize()
SDK-Wrapper-Methoden
Diese Methoden bieten bequemen Zugriff auf das zugrunde liegende SDK, sodass Aktionen mit Fällen, Benachrichtigungen und Plattformkonfigurationen interagieren können.
_add_attachment_to_current_case()_get_current_case_attachments()_add_comment_to_case()_get_current_case_comments()_assign_case_to_user()_add_tag_to_case()_attach_playbook_to_current_alert()_get_similar_cases_to_current_case()_get_alerts_ticket_ids_from_cases_closed_since_timestamp()_change_current_case_stage()_change_current_case_priority()_close_current_case()_close_alert()_escalate_case()_mark_case_as_important()_raise_incident()_add_entity_to_case()_update_alerts_additional_data()_get_current_integration_configuration()_any_alert_entities_in_custom_list()_add_alert_entities_to_custom_list()_remove_alert_entities_from_custom_list()
Beispielimplementierung
Das folgende Beispiel zeigt, wie Sie eine benutzerdefinierte Aktion implementieren, indem Sie von der Basisklasse Action erben.
from TIPCommon.base.actions.action_base import Action
from TIPCommon.validation import ParameterValidator
SOME_ACTION_SCRIPT_NAME = 'Some Integration - Some Action'
class SomeAction(Action):
def _validate_params(self) -> None:
validator = ParameterValidator(self.soar_action)
... # validation logic
def _perform_action(self, entity: Entity) -> None:
try:
self.logger.info('Querying Api client')
data = self.api_client.do_something(
param=self.params.query,
entity=entity.original_identifier
)
... # Some logic to process the data
except SomeCustomException as err:
self.error_output_message = (
"Action wasn't able to successfully do its thing."
)
raise err from err
def main() -> None:
SomeAction(SEARCH_GRAPHS_SCRIPT_NAME).run()
if __name__ == '__main__':
main()
Attribute
Die folgenden Properties bieten Lesezugriff oder verwalteten Zugriff auf Aktionsmetadaten, Ergebnisse und SDK-Objekte.
action_start_time
property action_start_time: int
Gibt einen int zurück, der die Startzeit der Aktion im Unix-Format darstellt.
api_client
property api_client: ApiClient | Collection[ApiClient] | Type[Tuple[ApiClient, ...]] | None
Gibt ein Apiable-Objekt zurück, das den für die Integration konfigurierten API-Client darstellt.
Anhängen
property attachments: list[Attachment]
Gibt eine Liste von Attachment-Objekten zurück, die die mit dieser Aktion verknüpften Anhänge des Fallergebnisses darstellen. Alle Anhänge in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
case_insights
property case_insights: list[CaseInsight]
Gibt eine Liste von CaseInsight-Objekten zurück, die allgemeine Ergebnisse im Zusammenhang mit dieser Aktion darstellen. Alle Fallstatistiken in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
Inhalt
property contents: list[Content]
Gibt eine Liste von Content-Objekten zurück, die Text-Ergebnisse für den Fall darstellen. Alle Inhalte in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
data_tables
property data_tables: list[DataTable]
Gibt eine Liste von DataTable-Objekten zurück, die tabellarische Dateneinblicke für den Fall darstellen. Alle Datentabellen in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
entities_to_update
property entities_to_update: list[DomainEntityInfo]
Gibt eine Liste von Entity-Objekten zurück, die nach Abschluss der Aktion auf der Plattform aktualisiert werden sollen.
entity_insights
property entity_insights: list[EntityInsight]
Gibt eine Liste von EntityInsight-Objekten zurück, die Ergebnisse darstellen, die mit bestimmten Entitäten verknüpft sind. Alle Entitätsstatistiken in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
entity_types
property entity_types: list[EntityTypesEnum]
Gibt eine Liste von EntityTypesEnum-Objekten zurück, die die Entitätstypen darstellen, die die Aktion verarbeiten soll. Wenn eine Aktion für Entitäten ausgeführt wird, werden nur Typen verarbeitet, die in dieser Liste aufgeführt sind.
error_output_message
property error_output_message: str
Ruft die Meldung ab, die auf der Plattform im Falle einer fehlgeschlagenen Ausführung angezeigt wird, oder legt sie fest.
Der Standardwert ist Action ACTION_NAME failed.
execution_state
property execution_state: ExecutionState
Gibt ein ExecutionState-Objekt zurück, das den endgültigen Verarbeitungsstatus darstellt. Folgende Statusangaben sind möglich:
ExecutionState.COMPLETED = 0ExecutionState.IN_PROGRESS = 1ExecutionState.FAILED = 2ExecutionState.TIMED_OUT = 3
global_context
global_context: dict
Ein Wörterbuch, das zum Speichern und Abrufen von Kontextinformationen während der Aktionsausführung verwendet wird.
html_reports
property html_reports: list[HTMLReport]
Gibt eine Liste von HTMLReport-Objekten zurück, die visuelle Berichte für das Fallergebnis darstellen. Alle HTML-Berichte in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
is_first_run
property is_first_run: bool
Gibt true zurück, wenn dies die erste Ausführung der Aktion ist, andernfalls false.
json_results
property json_results: Dict[str, Any] | List[Dict[str, Any]]
Gibt das formatierte JSON-Ergebnis zurück, das auf der Fallpinnwand angezeigt und in der nachfolgenden Playbook-Logik verwendet werden soll.
Links
property links: list[Link]
Gibt eine Liste von Link-Objekten zurück, die externe Referenz-URLs für das Fallergebnis darstellen. Alle Links in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
logger
property logger: NewLineLogger
Gibt die NewLineLogger-Instanz zurück, die für das skriptspezifische Logging verwendet wird.
Preisabschläge
property markdowns: list[Markdown]
Gibt eine Liste von Markdown-Objekten zurück, die formatierte Textstatistiken darstellen. Alle Markdowns in dieser Liste werden standardmäßig an das Fallergebnis gesendet.
Name
property name: str
Gibt den Stringnamen des Aktionsscripts zurück.
output_message
property output_message: str
Ruft die Nachricht ab, die auf der Plattform angezeigt wird und eine erfolgreiche Aktionsausführung zusammenfasst, oder legt sie fest.
params
property params: Container
Gibt ein Container-Objekt zurück, das die Eingabeparameter der Aktion beschreibt, wobei jeder Parameter als snake_case-Attribut verfügbar gemacht wird.
result_value
property result_value: bool
Ruft den Erfolgsindikator ab, der an die Plattform zurückgegeben wird, oder legt ihn fest.
True: Die Aktion war erfolgreich.False: Die Aktion ist fehlgeschlagen.
run
run(**kwargs)
Standardmethode zum Auslösen der Logik für die Aktionsausführung.
soar_action
property soar_action: SiemplifyAction
Gibt das zugrunde liegende SDK-Objekt SiemplifyAction zurück, das für die direkte Plattforminteraktion verwendet wird.
class TIPCommon.base.action.base_enrich_action.EnrichAction
class TIPCommon.base.action.base_enrich_action.EnrichAction(name: str)
Basis: Action
EnrichAction ist eine spezialisierte Basisklasse für Aktionen, die Entitätsattribute mit externen Daten aktualisieren.
Parameter
Der folgende Parameter ist erforderlich, um die Anreicherungsaktion zu initialisieren und auf der Plattform zu registrieren.
| Parameter | |
|---|---|
name |
Die eindeutige Kennung für das Skript der Anreicherungsaktion. |
Attribute
Mit den folgenden Attributen werden die Daten verwaltet, die während der Entitätsiterationen verwendet werden, und die Inhalte definiert, die in den Ausgabeergebnissen der Aktion enthalten sind.
| Attribute | |
|---|---|
enrichment_data |
Die Anreicherungsdaten für die aktuelle Entität in jeder der Entitätsiterationen. Am Ende jeder Iteration wird das Attribut |
entity_results |
Entitätsergebnisse, die in der JSON-Ausgabe für dieses Objekt enthalten sind. |
global_context |
Ein Wörterbuch, das zum Speichern und Freigeben von Kontextdaten in verschiedenen Phasen der Ausführung der Anreicherungsaktion verwendet wird. |
Abstrakte Methoden
Die folgenden abstrakten Methoden müssen in Unterklassen implementiert werden, um die spezifischen Entitätstypen und die Anreicherungslogik für die Aktion zu definieren.
| Abstrakte Methoden | |
|---|---|
_get_entity_types() |
Ruft den Typ der Entitäten ab, für die die Aktion ausgeführt wird. |
_perform_enrich_action() |
Führt die Hauptlogik für die Anreicherung einer Entität aus. |
Private Methoden
Diese internen Methoden übernehmen die Orchestrierung der Anreicherungslogik und sollten nicht geändert werden.
| Private Methoden | |
|---|---|
_perform_action() |
Diese Methode kombiniert die anderen abstrakten Methoden mit mehr OOTB-Anreicherungslogik und übergibt sie an die übergeordnete Klasse, um sie in der Methode |
Modul „Datenmodelle“
Dieses Modul enthält strukturierte Definitionen für integrationsübergreifende Objekte, Enums und Konstanten.
class TIPCommon.base.action.data_models.ActionParamType
class TIPCommon.base.action.data_models.ActionParamType(value)
Basis: Enum
ActionParamType definiert die unterstützten UI-Datentypen für Aktionsskriptparameter.
Konstanten
| Konstante | Wert |
|---|---|
BOOLEAN | 1 |
CASE_PRIORITIES | 7 |
CLOSE_CASE_REASONS | 5 |
CLOSE_ROOT_CAUSE | 6 |
CODE | 20 |
CONTENT | 11 |
DDL | 15 |
EMAIL_CONTENT | 10 |
ENTITY_TYPE | 13 |
MULTI_VALUES | 14 |
NULL | -1 |
PASSWORD | 12 |
PLAYBOOK_NAME | 2 |
STAGE | 4 |
STRING | 0 |
USER | 3 |
class TIPCommon.base.action.data_models.Attachment
class TIPCommon.base.action.data_models.Attachment(filename: str, file_contents: bytes, title: str = 'Script Result Attachment', additional_data: dict | None = None)
Basiert auf: object
Dieses Modell stellt einen Script-Ergebnis-Anhang dar, der in die Fallpinnwand hochgeladen werden soll.
Parameter
Die folgenden Parameter sind erforderlich, um ein Anhangsobjekt zu initialisieren und seine Metadaten sowie die Binärdaten zu definieren, die in die Anfrage hochgeladen werden sollen.
| Parameter | |
|---|---|
filename |
Der Name der Datei, die in den Ergebnissen der Rechtsangelegenheit erstellt werden soll. |
file_contents |
Die binären Rohdaten, die den Inhalt der Datei darstellen. |
title |
Der Anzeigetitel für den Anhang, wie er in der Plattform-UI angezeigt wird. Standardmäßig 'Script Result Attachment'. |
Attribute
Die folgenden Attribute definieren die Metadaten und den binären Inhalt des Dateianhangs, der vom Aktionsskript generiert wird.
| Attribute | |
|---|---|
title |
Der Titel des Anhangs, der auf der Benutzeroberfläche der Plattform angezeigt wird. |
filename |
Der spezifische Name der zu erstellenden Datei. |
file_contents |
Der binäre Rohinhalt der Anhangsdatei. |
additional_data |
Ein Wörterbuch mit zusätzlichen Daten, die mit dem Anhang verknüpft sind. |
class TIPCommon.base.action.data_models.CaseAttachment
class TIPCommon.base.action.data_models.CaseAttachment(attachment_id: int, attachment_type: str, description: str, is_favorite: bool)
Basiert auf: object
Diese Klasse stellt einen unveränderlichen Anhang dar, der mit einem Fall verknüpft ist.
Attribute
Die folgenden Attribute stellen die spezifischen Metadaten eines Anhangs dar, der bereits mit einem Fall innerhalb der Plattform verknüpft wurde.
| Attribute | |
|---|---|
attachment_id |
Die eindeutige, von der Plattform zugewiesene Kennung für den Anhang. |
attachment_type |
Die Klassifizierung oder der MIME-Typ des Anhangs (z. B. |
description |
Eine benutzerdefinierte oder vom System generierte Beschreibung des Inhalts des Anhangs. |
is_favorite |
Gibt an, ob der Anhang als Favorit für den Schnellzugriff auf der Fallpinnwand markiert wurde. |
class TIPCommon.base.action.data_models.CaseComment
class TIPCommon.base.action.data_models.CaseComment(comment: str, creator_user_id: str, comment_id: int, comment_type: int, case_id: int, is_favorite: bool, modification_time_unix_time_in_ms: int, creation_time_unix_time_in_ms: int, alert_identifier: str, creator_full_name: str | None = None, is_deleted: bool | None = None, last_editor: str | None = None, last_editor_full_name: str | None = None, modification_time_unix_time_in_ms_for_client: int | None = None, comment_for_client: str | None = None)
Basiert auf: object
CaseComment stellt einen unveränderlichen Datensatz eines Kommentars dar, der mit einem Fall oder einer Benachrichtigung verknüpft ist. Er enthält Details zum Ersteller und Zeitstempel für die Prüfung.
Attribute
Die folgenden Attribute definieren den Inhalt und die administrativen Metadaten eines Fallkommentars.
| Attribute | |
|---|---|
comment |
Der primäre Textinhalt des Kommentars. |
comment_for_client |
Eine optionale Version des Kommentars, die für die Sichtbarkeit für den Kunden angepasst ist. |
modification_time_unix_time_in_ms_for_client |
Der Änderungszeitstempel für die |
last_editor |
Die ID des letzten Bearbeiters, z. B. |
last_editor_full_name |
Der vollständige Anzeigename des Nutzers, der den Kommentar zuletzt bearbeitet hat, z. B. |
is_deleted |
Gibt an, ob der Kommentar als gelöscht markiert wurde. |
creator_user_id |
Die Nutzer-ID des Erstellers, z. B. |
creator_full_name |
Der vollständige Anzeigename des Erstellers, z. B. |
comment_id |
Die eindeutige, von der Plattform zugewiesene Ganzzahl-ID für den Kommentar. |
comment_type |
Die Schriftartkategorisierung des Kommentars. |
case_id |
Die ID des Falls, der mit diesem Kommentar verknüpft ist. |
is_favorite |
Gibt an, ob der Kommentar als Favorit angepinnt ist. |
modification_time_unix_time_in_ms |
Der Zeitpunkt der letzten Änderung des Kommentars in Unix-Millisekunden, z. B. |
creation_time_unix_time_in_ms |
Die Erstellungszeit des Kommentars in Unix-Millisekunden, z. B. |
alert_identifier |
Die spezifische Kennung der Benachrichtigung, die sich auf den Kommentar bezieht, z. B. |
class TIPCommon.base.action.data_models.CaseInsight
class TIPCommon.base.action.data_models.CaseInsight(triggered_by: str, title: str, content: str, severity: InsightSeverity, insight_type: InsightType, entity_identifier: str = '', additional_data: Any | None = None, additional_data_type: Any | None = None, additional_data_title: str | None = None)
Basiert auf: object
CaseInsight stellt eine unveränderliche strukturierte Zusammenfassung von Ergebnissen oder Warnungen dar, die auf der Fallpinnwand angezeigt wird.
Attribute
Die folgenden Attribute steuern, wie Statistiken kategorisiert und Analysten auf der Plattform präsentiert werden.
| Attribute | |
|---|---|
title |
Die Überschrift, die für die Statistik im Fall-Repository angezeigt wird. |
triggered_by |
Der Name der Integration oder des Nutzers, die bzw. der die Statistik generiert hat. |
content |
Der detaillierte Inhalt der Nachricht oder das Ergebnis des Insights. |
severity |
Die Dringlichkeitsstufe der Statistik. Folgende Werte sind möglich: infowarningerror |
insight_type |
Kategorisiert die Statistik. Folgende Werte sind möglich: generalentity |
entity_identifier |
Die spezifische Kennung für eine Entität, wenn die Statistik entitätsorientiert ist. |
additional_data |
Zusätzliche Daten, die mit der Statistik verknüpft sind. |
additional_data_type |
Die Datentypklassifizierung für das Attribut |
additional_data_title |
Der Anzeigetitel für den Block mit zusätzlichen Daten. |
class TIPCommon.base.action.data_models.CasePriority
class TIPCommon.base.action.data_models.CasePriority(value)
Basis: Enum
CasePriority definiert die ganzzahligen Schweregrade, die Fällen innerhalb der Plattform zugewiesen werden.
Konstanten
| Konstante | Wert |
|---|---|
CRITICAL | 100 |
HIGH | 80 |
INFORMATIONAL | 0 |
LOW | 40 |
MEDIUM | 60 |
class TIPCommon.base.action.data_models.CaseStage
class TIPCommon.base.action.data_models.CaseStage(value)
Basis: Enum
CaseStage gibt die Betriebsphasen an, die ein Fall während seines Lebenszyklus durchlaufen kann.
Konstanten
| Konstante | Wert |
|---|---|
ASSESSMENT | 'Assessment' |
IMPROVEMENT | 'Improvement' |
INCIDENT | 'Incident' |
INVESTIGATION | 'Investigation' |
RESEARCH | 'Research' |
TRIAGE | 'Triage' |
class TIPCommon.base.action.data_models.CloseCaseOrAlertInconclusiveRootCauses
class TIPCommon.base.action.data_models.CloseCaseOrAlertInconclusiveRootCauses(value)
Basis: Enum
CloseCaseOrAlertInconclusiveRootCauses bietet Optionen für die Ursache in Szenarien, in denen keine endgültige Bestimmung möglich ist.
Konstanten
| Konstante | Wert |
|---|---|
NO_CLEAR_CONCLUSION | „Kein klares Ergebnis“ |
class TIPCommon.base.action.data_models.CloseCaseOrAlertMaintenanceRootCauses
class TIPCommon.base.action.data_models.CloseCaseOrAlertMaintenanceRootCauses(value)
Basis: Enum
CloseCaseOrAlertMaintenanceRootCauses definiert Ursachen im Zusammenhang mit geplanten Tests, Systemwartungen oder der Regelentwicklung.
Konstanten
| Konstante | Wert |
|---|---|
LAB_TEST | „Labortest“ |
OTHER | „Sonstiges“ |
RULE_UNDER_CONSTRUCTION | „Regel im Aufbau“ |
class TIPCommon.base.action.data_models.CloseCaseOrAlertMaliciousRootCauses
class TIPCommon.base.action.data_models.CloseCaseOrAlertMaliciousRootCauses(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Basis: Enum
CloseCaseOrAlertMaliciousRootCauses bietet spezifische Kategorien für bestätigte Bedrohungen, Infrastrukturprobleme oder Systemstörungen.
Konstanten
| Konstante | Wert |
|---|---|
EXTERNAL_ATTACK | 'External attack' |
INFRASTRUCTURE_ISSUE | „Infrastrukturproblem“ |
IRRELEVANT_TCP_UDP_PORT | 'Irrelevanter TCP/UDP-Port' |
MISCONFIGURED_SYSTEM | „Falsch konfiguriertes System“ |
OTHER | „Sonstiges“ |
SIMILAR_CASE_IS_ALREADY_UNDER_INVESTIGATION | 'Ein ähnlicher Fall wird bereits geprüft' |
SYSTEM_APPLICATION_MALFUNCTION | „System-/Anwendungsstörung“ |
SYSTEM_CLOCKED_THE_ATTACK | „System hat den Angriff blockiert“ |
UNFORESEEN_EFFECTS_OF_CHANGE | 'Unvorhergesehene Auswirkungen von Änderungen' |
UNKNOWN | 'Unknown' |
class TIPCommon.base.action.data_models.CloseCaseOrAlertNotMaliciousRootCauses
class TIPCommon.base.action.data_models.CloseCaseOrAlertNotMaliciousRootCauses(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Basis: Enum
CloseCaseOrAlertNotMaliciousRootCauses definiert Kategorien für gutartige Aktivitäten, legitime Aktionen oder Fehler, die keine Bedrohung darstellen.
Konstanten
| Konstante | Wert |
|---|---|
EMPLOYEE_ERROR | „Fehler von Mitarbeitern“ |
HUMAN_ERROR | „Menschliches Versagen“ |
LAB_TEST | „Labortest“ |
LEGIT_ACTION | 'Legit action' |
MISCONFIGURED_SYSTEM | „Falsch konfiguriertes System“ |
NONE | 'None' |
NORMAL_BEHAVIOR | 'Normal behavior' |
OTHER | „Sonstiges“ |
PENETRATION_TEST | „Penetrationstest“ |
RULE_UNDER_CONSTRUCTION | „Regel im Aufbau“ |
SIMILAR_CASE_IS_ALREADY_UNDER_INVESTIGATION | 'Ein ähnlicher Fall wird bereits geprüft' |
UNKNOWN | 'Unknown' |
USER_MISTAKE | „Nutzerfehler“ |
class TIPCommon.base.action.data_models.CloseCaseOrAlertReasons
class TIPCommon.base.action.data_models.CloseCaseOrAlertReasons(value)
Basis: Enum
CloseCaseOrAlertReasons bietet standardisierte allgemeine Kategorien für die Gründe, warum ein Fall oder eine Benachrichtigung geschlossen wird.
Konstanten
| Konstante | Wert |
|---|---|
MALICIOUS | 0 |
NOT_MALICIOUS | 1 |
MAINTENANCE | 2 |
INCONCLUSIVE | 3 |
class TIPCommon.base.action.data_models.Content
class TIPCommon.base.action.data_models.Content(content: str, title: str = 'Script Result Content')
Basiert auf: object
Content stellt ein unveränderliches Textergebnis dar, das von einem Skript generiert wurde, um es der Fallpinnwand hinzuzufügen.
Attribute
Die folgenden Attribute definieren den text- oder markdownbasierten Inhalt, der in den Fallergebnissen auf der Plattform angezeigt wird.
| Attribute | |
|---|---|
title |
Der Anzeigetitel für den Inhaltsblock, wie er in der Benutzeroberfläche für Skriptergebnisse angezeigt wird. |
content |
Der eigentliche Inhalt der Nachricht, der als Rohtextstring oder im Markdown-Format bereitgestellt werden kann. |
class TIPCommon.base.action.data_models.DataTable
class TIPCommon.base.action.data_models.DataTable(data_table: list[str], title: str = 'Script Result Data Table')
Basiert auf: object
DataTable stellt eine Liste von CSV-formatierten Strings dar, die in den Fallergebnissen als strukturierte Tabelle gerendert werden.
Attribute
Die folgenden Attribute definieren die Struktur und Darstellung tabellarischer Daten in der Ergebnismenge der Aktion.
| Attribute | |
|---|---|
title |
Die Überschrift, die in der Benutzeroberfläche der Plattform über der Datentabelle angezeigt wird. |
data_table |
Eine Liste von Strings, wobei jedes Element eine CSV-formatierte Zeile darstellt, aus der die Tabelle erstellt wird. |
class TIPCommon.base.action.data_models.EntityInsight
class TIPCommon.base.action.data_models.EntityInsight(entity: DomainEntityInfo, message: str, triggered_by: str | None = None, original_requesting_user: str | None = None)
Basiert auf: object
EntityInsight wird verwendet, um spezifische Ergebnisse zu erstellen, die mit einer Entität verknüpft sind. Diese werden häufig in der Detailansicht der Entität angezeigt.
Attribute
Die folgenden Attribute definieren die Beziehung zwischen einer Entität und den Ergebnissen, die von einem Integrationsskript generiert werden.
| Attribute | |
|---|---|
entity |
Das Entitätsobjekt, das mit neuen Ergebnissen angereichert wird. |
message |
Die wichtigste Beobachtung, das wichtigste Ergebnis oder die wichtigste beschreibende Nachricht für die Entität. |
triggered_by |
Der Name der Integration, die das Ergebnis identifiziert hat. |
original_requesting_user |
Die eindeutige Kennung des Nutzers, der die Anfrage ursprünglich initiiert hat. |
class TIPCommon.base.action.data_models.EntityTypesEnum
class TIPCommon.base.action.data_models.EntityTypesEnum(value)
Basis: Enum
EntityTypesEnum stellt Konstanten für alle von Google SecOps erkannten Entitätstypen bereit.
Konstanten
Die folgenden Konstanten definieren die standardisierten Entitätstypen, die von der Plattform für Anreicherungs- und Automatisierungsaufgaben unterstützt werden.
| Konstante | Wert |
|---|---|
ADDRESS | 'ADDRESS' |
ALERT | 'ALERT' |
APPLICATION | 'APPLICATION' |
CHILD_HASH | 'CHILDHASH' |
CHILD_PROCESS | 'CHILDPROCESS' |
CLUSTER | 'CLUSTER' |
CONTAINER | 'CONTAINER' |
CREDIT_CARD | 'CREDITCARD' |
CVE | 'CVE' |
CVE_ID | 'CVEID' |
DATABASE | 'DATABASE' |
DEPLOYMENT | 'DEPLOYMENT' |
DESTINATION_DOMAIN | 'DESTINATIONDOMAIN' |
DOMAIN | 'DOMAIN' |
EMAIL_MESSAGE | 'EMAILSUBJECT' |
EVENT | 'EVENT' |
FILE_HASH | 'FILEHASH' |
FILE_NAME | 'FILENAME' |
GENERIC | 'GENERICENTITY' |
HOST_NAME | 'HOSTNAME' |
IP_SET | 'IPSET' |
MAC_ADDRESS | 'MacAddress' |
PARENT_HASH | 'PARENTHASH' |
PARENT_PROCESS | 'PARENTPROCESS' |
PHONE_NUMBER | 'PHONENUMBER' |
POD | 'POD' |
PROCESS | 'PROCESS' |
SERVICE | 'SERVICE' |
SOURCE_DOMAIN | 'SOURCEDOMAIN' |
THREAT_ACTOR | 'THREATACTOR' |
THREAT_CAMPAIGN | 'THREATCAMPAIGN' |
THREAT_SIGNATURE | 'THREATSIGNATURE' |
URL | 'DestinationURL' |
USB | 'USB' |
USER | 'USERUNIQNAME' |
class TIPCommon.base.action.data_models.ExecutionState
class TIPCommon.base.action.data_models.ExecutionState(value)
Basis: Enum
ExecutionState stellt den endgültigen Statusindikator dar, der an die Plattform zurückgegeben wird, um den Erfolg oder Misserfolg einer Aktion zu bestimmen.
Konstanten
| Konstante | Wert |
|---|---|
COMPLETED | 0 |
IN_PROGRESS | 1 |
FAILED | 2 |
TIMED_OUT | 3 |
class TIPCommon.base.action.data_models.FullDetailsConfigurationParameter
class TIPCommon.base.action.data_models.FullDetailsConfigurationParameter(input_dict: dict[str, Any])
Basiert auf: object
FullDetailsConfigurationParameter kapselt einen allgemeinen Integrationskonfigurationsparameter mit seinen vollständigen Metadaten, wie sie von der API abgerufen werden.
Attribute
Mit den folgenden Attributen werden Parametermetadaten, Identifikation und Konfigurationseinschränkungen verwaltet.
table>
Attribute
full_dict
dict[str, Any]
Das ursprüngliche Wörterbuch, das von der API-Antwort empfangen wurde.
id
int | None
Die eindeutige, von der Plattform zugewiesene Kennung für den Parameter.
integration_identifier
str
Die Kennung für die Integration, die mit diesem Parameter verknüpft ist, z. B. VirusTotalV3.
creation_time
int
Der Zeitstempel, der angibt, wann der Parameter erstellt wurde, in Unix-Millisekunden.
modification_time
int
Der Zeitstempel, der angibt, wann der Parameter zuletzt geändert wurde, in Unix-Millisekunden.
is_mandatory
bool
Definiert, ob der Parameter für die Integration erforderlich ist.
description
str | None
Die detaillierte Beschreibung des Zwecks des Parameters.
name
str
Der interne Kennungsname für den Parameter.
display_name
str
Der menschenlesbare Name des Parameters, wie er auf der Plattformoberfläche angezeigt wird.
value
Any
Der Standardwert, der dem Parameter zugewiesen ist.
type
IntegrationParamType
Die Datentypklassifizierung des Parameters.
optional_values
list
Eine Liste optionaler Werte für Drop-down-Parameter (DDL).
class TIPCommon.base.action.data_models.HTMLReport
class TIPCommon.base.action.data_models.HTMLReport(report_name: str, report_contents: str, ...)
Basiert auf: object
HTMLReport stellt eine benutzerdefinierte HTML-basierte Visualisierung dar, die den Fallergebnissen hinzugefügt werden soll.
Attribute
| Attribute | |
|---|---|
title |
Der angezeigte Titel für den Bericht im Fall-Repository. |
report_name |
Die interne Kennung oder der Dateiname für den Bericht. |
report_contents |
Der HTML-Rohstring, der den Inhalt des Berichts definiert. |
class TIPCommon.base.action.data_models.IntegrationParamType
class TIPCommon.base.action.data_models.IntegrationParamType(value)
Basis: Enum
IntegrationParamType gibt die unterstützten Datentypen für Integrationskonfigurationseinstellungen an.
Konstanten
| Konstante | Wert |
|---|---|
NULL | -1 |
BOOLEAN | 0 |
INTEGER | 1 |
STRING | 2 |
PASSWORD | 3 |
IP | 4 |
EMAIL | 8 |
class TIPCommon.base.action.data_models.Link
class TIPCommon.base.action.data_models.Link(link: str, title: str = 'Script Result Link')
Basiert auf: object
Link steht für ein externes URL-Ergebnis, das als Hyperlink auf der Fallpinnwand angezeigt werden soll.
Attribute
| Attribute | |
|---|---|
title |
Der Anzeigetext für den Hyperlink. |
link |
Die Ziel-URL für den Link. |
class TIPCommon.base.action.data_models.Markdown
class TIPCommon.base.action.data_models.Markdown(markdown_name: str, markdown_content: str, ...)
Basiert auf: object
Markdown bietet eine strukturierte Möglichkeit, Rich-Text-formatierten Inhalt mithilfe der Markdown-Syntax zurückzugeben.
Attribute
| Attribute | |
|---|---|
title |
Der Anzeigetitel für den Markdown-Block. |
markdown_content |
Der Inhalt im Markdown-Format. |
markdown_name |
Der eindeutige Name, der diesem Markdown-Ergebnis zugewiesen ist. |
class TIPCommon.base.action.data_models.ScriptParameter
class TIPCommon.base.action.data_models.ScriptParameter(input_dict: dict[str, Any])
Basiert auf: object
ScriptParameter stellt einen einzelnen Eingabeparameter für ein Aktionsskript dar und verwaltet seinen Wert, seinen Standardstatus und seine Sichtbarkeit in Playbooks oder manuellen Aktionen.
Attribute
Mit den folgenden Attributen werden die Metadaten, die Wertpriorisierung und die Dateneinschränkungen für einzelne Skriptparameter verwaltet.
| Attribute | |
|---|---|
full_dict |
Das ursprüngliche Wörterbuch, das von der API-Antwort empfangen wurde. |
id |
Die eindeutige, von der Plattform zugewiesene Kennung für den Parameter. |
creation_time |
Der Zeitstempel, der angibt, wann der Parameter erstellt wurde, in Unix-Millisekunden. |
modification_time |
Der Zeitstempel, der angibt, wann der Parameter zuletzt geändert wurde, in Unix-Millisekunden. |
custom_action_id |
Die Kennung der benutzerdefinierten Aktion, die mit diesem Parameter verknüpft ist. |
is_mandatory |
Gibt an, ob der Parameter für die Ausführung des Aktionsskripts angegeben werden muss. |
default_value |
Der Standardwert des Parameters. Dieser Wert wird bei Playbook-Ausführungen gegenüber |
description |
Die detaillierte Beschreibung des Zwecks des Parameters. |
name |
Der interne Kennungsname für den Parameter. |
value |
Der aktuelle Wert des Parameters. Dieser Wert hat bei der Ausführung manueller Aktionen Vorrang vor |
type |
Die Datentypklassifizierung des Parameters. |
optional_values |
Eine Liste optionaler Werte für Parameter vom Typ „Drop-down-Liste“ (DDL). |
Ergebnisse der Scriptausführung
Die folgenden Klassen und Funktionen definieren die standardisierten Strukturen für die Rückgabe von Daten aus Aktionen und Connectors an die Plattform.
class TIPCommon.base.data_models.ActionJsonOutput
class TIPCommon.base.data_models.ActionJsonOutput(title='JsonResult', content='', type=None, is_for_entity=False, json_result=None)
Basiert auf: object
ActionJsonOutput stellt die strukturierte JSON-Nutzlast für eine Aktion dar und ermöglicht eine spezifische Kategorisierung und Ausrichtung auf Entitätsebene.
Attribute
| Attribute | |
|---|---|
title |
Der Anzeigetitel für den JSON-Ergebnisblock. |
content |
Textinhalt oder eine Zusammenfassung, die die JSON-Daten begleitet. |
type |
Ein optionaler Klassifizierungstyp für die JSON-Ausgabe. |
is_for_entity |
Gibt an, ob das JSON-Ergebnis speziell mit einer Entität verknüpft ist. |
json_result |
Die tatsächliche strukturierte JSON-Datennutzlast. |
class TIPCommon.base.data_models.ActionOutput
class TIPCommon.base.data_models.ActionOutput(output_message, result_value, execution_state, json_output, debug_output='')
Basiert auf: object
ActionOutput kapselt die vollständige Ergebnisstruktur für eine Aktion und kombiniert menschenlesbare Nachrichten, Status und strukturiertes JSON.
Attribute
| Attribute | |
|---|---|
output_message |
Die Hauptzusammenfassung, die dem Analysten angezeigt wird. |
result_value |
Das logische Ergebnis der Aktion (z.B. Erfolg/Fehler). |
execution_state |
Der endgültige Lebenszyklusstatus der Aktionsausführung. |
json_output |
Die strukturierten JSON-Ergebnisse der Aktion. |
debug_output |
Optionale Diagnoseinformationen zur Fehlerbehebung. |
class TIPCommon.base.data_models.ConnectorJsonOutput
class TIPCommon.base.data_models.ConnectorJsonOutput(alerts, overflow_alerts=<factory>, log_items=<factory>, log_rows=<factory>, variables=<factory>)
Basiert auf: object
ConnectorJsonOutput definiert die strukturierten Daten, die von einem Connector zurückgegeben werden, einschließlich aufgenommener Benachrichtigungen, Überlaufdetails und Ausführungslogs.
Attribute
| Attribute | |
|---|---|
alerts |
Eine Liste der erfolgreich aufgenommenen Benachrichtigungs- oder Fallobjekte. |
overflow_alerts |
Eine Liste der Benachrichtigungen, die die Aufnahmelimits überschritten haben und als Überlauf behandelt wurden. |
log_items |
Eine Liste strukturierter Logeinträge, die während der Connector-Ausführung generiert wurden. |
variables |
Ein Dictionary mit Statusvariablen, die zwischen Connector-Ausführungen beibehalten werden. |
class TIPCommon.base.data_models.ConnectorOutput
class TIPCommon.base.data_models.ConnectorOutput(json_output, debug_output='')
Basiert auf: object
ConnectorOutput ist der übergeordnete Container für die Ergebnisse der Connector-Ausführung und enthält die strukturierten JSON-Daten und optionale Debug-Strings.
Attribute
| Attribute | |
|---|---|
json_output |
Die strukturierten JSON-Ergebnisse mit Aufnahme- und Logdaten. |
debug_output |
Optionaler Debugging-String für internes Diagnosetracking. |
TIPCommon.base.data_models.alert_info_from_json
TIPCommon.base.data_models.alert_info_from_json(json_) → AlertInfo
Erstellt ein AlertInfo-Objekt, indem ein Wörterbuch mit Attributen geparst wird.
Dies wird normalerweise verwendet, um Benachrichtigungsobjekte während der Datentransformation oder des Tests zu rekonstruieren.
Gibt Folgendes zurück:
Gibt ein vollständig initialisiertes AlertInfo-Objekt basierend auf den im bereitgestellten JSON-Wörterbuch definierten Attributen zurück.
Modul „Schnittstellen“
In diesem Modul werden abstrakte Standardverträge für grundlegende Skriptkomponenten definiert.
class TIPCommon.base.interfaces.apiable.Apiable
class TIPCommon.base.interfaces.apiable.Apiable(authenticated_session: AuthenticatedSession, configuration: ApiParams)
Basis: ABC, Generic[ApiParams]
Apiable ist eine abstrakte Basisschnittstelle für Klassen, die die API-Kommunikationslogik kapseln und eine einheitliche Struktur für Interaktionen mit externen Diensten gewährleisten.
class TIPCommon.base.interfaces.authable.Authable
class TIPCommon.base.interfaces.authable.Authable
Basis: ABC, Generic[AuthParams]
Authable ist eine abstrakte Basisschnittstelle für Klassen, die Authentifizierungsworkflows verwalten. Sie bietet eine standardisierte Vorlage zum Einrichten sicherer Sitzungen mit externen Diensten.
Abstrakte Methoden
Die folgenden abstrakten Methoden müssen in abgeleiteten Klassen implementiert werden, um die spezifische Authentifizierungslogik zu definieren, die für den Zieldienst erforderlich ist.
| Abstrakte Methoden | |
|---|---|
authenticate_session() |
Authentifiziert das Attribut Verwenden Sie diese Methode, um die Authentifizierung mit dem Dienst herzustellen, der der Sitzung zugeordnet ist, nachdem das Sitzungsobjekt initialisiert wurde. |
class TIPCommon.base.interfaces.logger.Logger
class TIPCommon.base.interfaces.logger.Logger
Basis: ABC
Die Logger-Schnittstelle, die dafür sorgt, dass Content Hub-Skripts eine standardisierte Diagnoseausgabe bereitstellen.
Abstrakte Methoden
Die folgenden Methoden müssen implementiert werden, um verschiedene Protokollierungsschweregrade und die Meldung von Ausnahmen zu verarbeiten.
| Abstrakte Methoden | |
|---|---|
debug() |
Protokolliert eine Nachricht mit dem Schweregrad |
info() |
Protokolliert eine Nachricht mit dem Schweregrad |
warn() |
Protokolliert eine Nachricht mit dem Schweregrad |
error() |
Protokolliert eine Nachricht mit dem Schweregrad |
exception() |
Protokolliert eine Nachricht mit dem Schweregrad |
class TIPCommon.base.interfaces.session.Session
class TIPCommon.base.interfaces.session.Session
Bases: ABC, Generic[_R]
Die Session-Schnittstelle bietet eine einheitliche Vorlage für die Verwaltung von API-Sitzungen mit verschiedenen HTTP-Bibliotheken.
Attribute
Mit den folgenden Attributen werden die Konfigurations- und Sicherheitseinstellungen der eingerichteten HTTP-Kommunikationssitzung verwaltet.
| Attribute | |
|---|---|
headers |
Ein Dictionary mit den HTTP-Headern, die mit jeder Anfrage in der Sitzung gesendet werden sollen. |
verify |
Ein boolescher Wert, der angibt, ob die Sitzung das SSL-Zertifikat des Servers überprüfen soll. |
Abstrakte Methoden
Die folgenden abstrakten Methoden definieren die Standard-HTTP-Verben und den primären Anfrage-Dispatcher, den abgeleitete Klassen implementieren müssen.
| Abstrakte Methoden | |
|---|---|
get() |
Ruft eine Ressource mit einer HTTP-GET-Anfrage vom Server ab. |
post() |
Sendet Daten an den Server, um eine Ressource mit einer HTTP-POST-Anfrage zu erstellen. |
put() |
Aktualisiert oder erstellt eine Ressource auf dem Server mithilfe einer HTTP-PUT-Anfrage. |
patch() |
Wendet mithilfe einer HTTP-PATCH-Anfrage teilweise Änderungen auf eine Ressource an. |
delete() |
Entfernt eine angegebene Ressource mithilfe einer HTTP-DELETE-Anfrage vom Server. |
request() |
Der zentrale Anfrage-Dispatcher, der zum Ausführen einer HTTP-Anfrage mit einer angegebenen Methode verwendet wird. |
Modul „Jobs“
Dies bietet das Framework für Skripts zur Hintergrundverarbeitung, die nach einem definierten Zeitplan innerhalb der Plattform ausgeführt werden.
class TIPCommon.base.job.base_job.Job
class TIPCommon.base.job.base_job.Job(name: str)
Basis: ABC, Generic[ApiClient]
Job ist eine abstrakte Basisklasse, die für geplante Aufgaben entwickelt wurde, die unabhängige Hintergrundvorgänge wie Datensynchronisierung oder Systemdiagnosen ausführen.
Parameter
Der folgende Parameter ist erforderlich, um den Job zu initialisieren und auf der Plattform zu registrieren.
| Parameter | |
|---|---|
name |
Die eindeutige Kennung, die zum Registrieren und Identifizieren des Jobskripts verwendet wird. |
Attribute
Die folgenden Attribute ermöglichen den Zugriff auf den Ausführungskontext, die Konfiguration und die integrierten Dienstclients des Jobs.
| Attribute | |
|---|---|
api_client |
Stellt den initialisierten API-Client oder die Sammlung von Clients für die Interaktion mit externen Diensten bereit. |
error_msg |
Speichert alle Fehlermeldungen, die während der Ausführung des Jobs für die Diagnoseberichterstellung aufgetreten sind. |
job_start_time |
Der Unix-Zeitstempel, der angibt, wann die Jobausführung begonnen hat. |
logger |
Stellt die Logging-Schnittstelle zum Erfassen von Informations-, Warn- und Fehlerdaten während der Ausführung bereit. |
name |
Der registrierte Name des Jobskripts. |
params |
Ein Container mit den spezifischen Konfigurationsparametern, die für die Jobinstanz bereitgestellt werden. |
soar_job |
Stellt die zugrunde liegende Plattformjobinstanz dar und bietet Zugriff auf Low-Level-Ausführungs-Hooks. |
Methoden
Mit den folgenden Methoden werden die Orchestrierung und der Ausführungslebenszyklus des Jobs verwaltet.
| Methoden | |
|---|---|
start() |
Unterschrift: Der primäre Einstiegspunkt, der die Ausführungslogik des Jobs auslöst. |
class TIPCommon.base.job.base_job_refresh_token.RefreshTokenRenewalJob
class TIPCommon.base.job.base_job_refresh_token.RefreshTokenRenewalJob(name: str, integration_identifier: str)
Basis: Job, Generic[ApiClient]
RefreshTokenRenewalJob stellt die Lebenszyklusmethoden bereit, die die Jobverarbeitung für die Tokenwartung beeinflussen. Abgeleitete Klassen müssen diese Methoden nicht überschreiben.
Attribute
| Attribute | |
|---|---|
api_client |
Der initialisierte API-Client oder die initialisierten API-Clients, die für Interaktionen mit externen Diensten verwendet werden. |
class TIPCommon.base.job.base_job_refresh_token.SuccessFailureTuple
class TIPCommon.base.job.base_job_refresh_token.SuccessFailureTuple(success_list, failure_list)
Basen: Tupel
SuccessFailureTuple ist ein spezielles benanntes Tupel, mit dem die Ergebnisse von Batchjobvorgängen in Erfolge und Fehler kategorisiert werden.
Attribute
| Attribute | |
|---|---|
success_list |
Eine Liste mit den Kennungen oder Objekten, die erfolgreich verarbeitet wurden. |
failure_list |
Eine Liste mit den Kennungen oder Objekten, die nicht verarbeitet werden konnten. |
TIPCommon.base.job.base_job_refresh_token.validate_param_csv_to_multi_value
TIPCommon.base.job.base_job_refresh_token.validate_param_csv_to_multi_value(param_name, param_csv_value, delimiter=',') → list[str]
Diese Funktion validiert und parst einen kommagetrennten Parameterstring (CSV) in eine Liste eindeutiger Elemente. Sie ist für die Verarbeitung komplexer Formate konzipiert, einschließlich einzelner Werte, Strings in Anführungszeichen und gemischter Eingaben.
Parameter
| Parameter | |
|---|---|
param_name |
Der Name oder Schlüssel des Parameters, der validiert wird. |
param_csv_value |
Der in der Jobkonfiguration angegebene CSV-Rohstring. Gibt eine leere Liste zurück, wenn |
Löst aus
Eine ValueError-Ausnahme wird ausgelöst, wenn der Eingabestring eine ungültige Anzahl von doppelten Anführungszeichen oder nicht übereinstimmende Anführungszeichen enthält oder wenn einzelne Werte in der CSV-Datei die Validierung nicht bestehen.
Gibt Folgendes zurück:
Eine list[str]-Liste mit eindeutigen, validierten Strings, die aus der Eingabe geparst wurden. Wenn keine gültigen Werte identifiziert werden oder die Eingabe None ist, wird eine leere Liste zurückgegeben.
class TIPCommon.base.job.data_models.JobParameter
class TIPCommon.base.job.data_models.JobParameter(input_dict: MutableMapping[str, Any])
Basiert auf: object
JobParameter stellt einen einzelnen Konfigurationsparameter für ein Jobskript dar und verwaltet dessen Metadaten und Wertstatus.
Attribute
| Attribute | |
|---|---|
full_dict |
Das ursprüngliche Wörterbuch, das während der Jobinitialisierung von der API empfangen wurde. |
id |
Die eindeutige, von der Plattform zugewiesene Kennung für den Jobparameter. |
is_mandatory |
Gibt an, ob der Parameter für die Ausführung des Jobs angegeben werden muss. |
name |
Der interne Kennungsname für den Parameter. |
type |
Die Datentypklassifizierung des Parameters. |
value |
Der Standardwert des Parameters. Dieser Wert wird in der Regel bei automatisierten Jobausführungen priorisiert. |
Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten