extraction モジュール

extraction モジュールには、さまざまなプラットフォーム オブジェクトからパラメータ値を取得するための標準化された関数が含まれています。これらのユーティリティにより、データが正しく型指定され、検証されます。また、必須フィールドのチェックと空白文字の管理がサポートされるため、シームレスな統合開発が可能になります。

TIPCommon.extraction.extract_action_param

TIPCommon.extraction.extract_action_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

siemplify オブジェクトからアクション パラメータを抽出します。

パラメータ

パラメータ
siemplify SiemplifyAction.SiemplifyAction

アクションの実行に使用される siemplify オブジェクト。

param_name str

抽出するパラメータの名前。

default_value Any

パラメータが見つからない場合に返すデフォルト値。

input_type type

パラメータの想定されるデータ型。

is_mandatory bool

パラメータが必須かどうかを示します。

remove_whitespaces bool

値から先頭と末尾の空白文字が削除されるかどうかを示します。

戻り値

抽出されたパラメータ値。

戻り値の型

Any

TIPCommon.extraction.extract_configuration_param

TIPCommon.extraction.extract_configuration_param(siemplify, provider_name, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

統合のグローバル構成から構成パラメータ値を抽出します。

パラメータ

パラメータ
provider_name str

インテグレーションの固有識別子。

param_name str

取得する特定の構成キー。

戻り値

抽出された構成値。

TIPCommon.extraction.extract_connector_param

TIPCommon.extraction.extract_connector_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

コネクタの実行中に siemplify オブジェクトからコネクタ パラメータを抽出します。

パラメータ

パラメータ
siemplify SiemplifyConnectors.SiemplifyConnectorExecution

コネクタの実行に使用される siemplify オブジェクト。

戻り値

コネクタ パラメータの値。

戻り値の型

Any

TIPCommon.extraction.extract_job_param

TIPCommon.extraction.extract_job_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

siemplify ジョブ オブジェクトからジョブ パラメータを抽出します。

パラメータ

パラメータ
siemplify SiemplifyJob.SiemplifyJob

現在のジョブ インスタンスの siemplify オブジェクト。

戻り値

抽出されたジョブ パラメータ値。

TIPCommon.extraction.extract_script_param

TIPCommon.extraction.extract_script_param(siemplify, input_dictionary, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

指定された入力ディクショナリからスクリプト パラメータを抽出します。

パラメータ

パラメータ
input_dictionary dict

スクリプト パラメータを含むディクショナリ ソース。

戻り値

辞書から抽出されたパラメータ値。

TIPCommon.extraction.get_connector_detailed_params

TIPCommon.extraction.get_connector_detailed_params(siemplify)

コネクタ用に特別に定義されたパラメータの詳細なリストを取得します。

パラメータ

パラメータ
siemplify SiemplifyConnectors.SiemplifyConnectorExecution

コネクタの siemplify オブジェクト。

戻り値

ConnectorParameter オブジェクトのリスト。

戻り値の型

list