SiemplifyJob モジュール

クラス SiemplifyJob.SiemplifyJob

ベース: Siemplify

エンドポイント: external/v1/sdk/GetFailedETLOperations

extract_job_param

extract_job_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

インテグレーション インスタンスから構成パラメータを取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
param_name	{string}	取得するパラメータの名前	なし	なし
default_value	{any}	パラメータのデフォルト値		（省略可） パラメータが設定されていない場合（is_mandatory が False に設定されている場合）、指定された値が返されます。 デフォルトでは None
input_type	{obj}	パラメータの型	なし	（省略可） 戻り値は、選択した入力タイプにキャストされます。 デフォルトでは {str}
is_mandatory	{boolean}	パラメータが必須かどうかを定義します。	なし	（省略可） True に設定されていて、パラメータが入力されていない場合、例外が発生します。デフォルトでは False
print_value	{boolean}	パラメータの取得値をログに出力するかどうかを定義します。	なし	（省略可） デフォルトでは False

戻り値

パラメータ値。input_type が指定されていない場合は、デフォルトで文字列。

例

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
param_value= siemplify.extract_job_param(
                                       "Logs Folder",
                                       default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
                                       input_type=str,
                                       is_mandatory=False,
                                       print_value=False)

結果の動作

選択したパラメータの値が、選択した型にキャストされて返されます。

結果値

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

タイムスタンプを取得してケース コンテキストに保存します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
datetime_format	{boolean}	日付/時刻の形式	True（datetime 形式で取得）、 、False（Unix）	デフォルトは False（省略可）
タイムゾーン	パラメータのサポートが終了しました
new_timestamp	{int}	保存するタイムスタンプ	なし	デフォルトでは Unix エポック時間（省略可）

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

save_timestamp で保存されたタイムスタンプを取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
datetime_format	{boolean}	True の場合、タイムスタンプを datetime として返します。 それ以外の場合は、Unix で返します。	True/False	デフォルトは False（省略可）
タイムゾーン	パラメータのサポートが終了しました

戻り値

保存された Unix 時間/日時。

get_configuration

get_configuration(provider, environment=None, integration_instance=None)

統合構成を取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
provider	{string}	連携名	VirusTotal	統合プロバイダ名では大文字と小文字が区別されます。 統合がインストールされていない場合、または文字列が存在しない場合は、エラーがスローされます。
環境	{string}	特定の環境または「すべて」の構成	なし	（省略可） 指定されている場合、認証情報は対応する 環境構成から取得されます。環境が指定されていない場合は、デフォルトでケース環境が使用されます。 特定の 環境の構成がない場合、デフォルトの構成が返されます。
integration_instance	{string}	統合インスタンスの識別子	なし	なし

戻り値

{dict} 構成の詳細

例

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")

結果の動作

Google Security Operations Marketplace からの統合用に保存された認証情報を含む辞書が返されます。

結果値

{
u'AgentIdentifier': None,
u'Api Key': u'c0c412#########################4f85b22e707',
u'Verify SSL': u'True',
u'RunRemotely': u'False'
}

get_failed_actions

get_failed_actions(number_of_hours)

指定した時間内に失敗したすべての ETL ジョブを取得します。

戻り値

{dict} 個のジョブが失敗しました

{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}

get_failed_etljobs

get_failed_etljobs(number_of_hours)

指定した時間内に失敗したすべての ETL ジョブを取得します。

戻り値

{dict} 個のジョブが失敗しました

{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

start_unix_time と end_unix_time の間に失敗したコネクタをすべて取得します。

戻り値

{dict} 失敗したコネクタ

結果値

{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}

get_faulted_jobs

get_faulted_jobs(number_of_hours)

指定した時間内に失敗したすべてのジョブを取得します。

戻り値

{[dict]} 失敗したジョブ

結果値

[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]

get_job_context_property

get_job_context_property(identifier, property_key)

指定されたキーでジョブ コンテキスト値を取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
identifier	{string}	コンテキスト ID	なし	なし
property_key	{string}	取得するプロパティのキー	なし	なし

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

ジョブの一意の識別子を使用して、スコープ設定されたジョブ コンテキスト プロパティを取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
property_key	{string}	ジョブのコンテキスト プロパティのキー	なし	なし

戻り値

特定のキーの値。

get_system_info

get_system_info(start_time_unixtime_ms)

プロパティ log_location

save_publisher_logs

save_publisher_logs(records)

パブリッシャー ログレコードを保存します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
records	{list}	保存するレコード	なし	なし

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

タイムスタンプを保存します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
datetime_format	{boolean}	なし	datetime 形式の場合は True、Unix の場合は False	デフォルトは False です（省略可）。
タイムゾーン	パラメータのサポートが終了しました
new_timestamp	{long}	コンテキストに保存するタイムスタンプ	なし	タイムスタンプは、メソッドを呼び出したときの Unix タイムスタンプがデフォルト

send_mail

send_mail(subject, message, recipients, attachment_file_name, attachment_content)

メールを送信する（添付ファイル可）。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
件名	{string}	メールの件名	なし	なし
メッセージ	{string}	メール文	なし	なし
attachment_file_name	{string}	添付ファイルのファイル名	なし	なし
受信者	{[{string}]}	受信者のリスト	なし	なし

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

ジョブの一意の識別子を使用して、スコープ付きジョブ コンテキスト プロパティを設定します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
identifier	{string}	コンテキスト ID	なし	なし
property_key	{string}	ジョブのコンテキスト プロパティのキー	なし	なし
property_value	{string}	ジョブのコンテキスト プロパティの値	なし	なし

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

ジョブの一意の識別子を使用して、スコープ付きジョブ コンテキスト プロパティを設定します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
property_key	{string}	ジョブのコンテキスト プロパティのキー	なし	なし
property_value	{string}	ジョブのコンテキスト プロパティの値	なし	なし