Azure Service Busトリガーチュートリアル - C#ライブラリ APIリファレンス

名前空間

Appresso.DataSpider.Service

クラス

AppFabricTriggerService


Azure Service Busトリガーにメッセージを送信し、トリガーを発火させるためのクラスです。
スクリプト入力変数に値を渡したい場合は、このクラスのインスタンスに対して値を設定します。
またメッセージ送信後、このクラスからスクリプト実行結果を保持するExecutionResponseクラスのインスタンスを取得します。

AppFabricTriggerService型で公開されるメンバは以下の通りです。

コンストラクタ
public AppFabricTriggerService(string serviceNamespace, string servicePath, string defaultIssuer, string defaultKey)

AppFabricTriggerServiceのインスタンスを生成します。
パラメータには、Azure Service Busトリガーが開始したAzure Service Busサービスへ接続するための情報を指定します。

パラメータ:
  • serviceNamespace: サービス名前空間(Service Namespace)
  • serviceNamespace: サービスパス(Service Path)
  • defaultIssuer: 既定の発行者(Default Issuer)
  • defaultKey: 既定のキー(Default Key)
プロパティ
public int RetrieveTimeoutSec

メッセージ受信時のタイムアウト秒数を取得または設定します。
デフォルトは20秒です。

1以上120以下の整数を設定してください。
public int RetrieveRetryTimes

メッセージ受信の再試行回数を取得または設定します。
デフォルトは10回です。

0以上2147483647以下の整数を設定してください。
メソッド
public ExecutionResponse Execute()

Azure Service Busトリガーへメッセージの送信を行い、トリガーを発火させます。
実行スクリプトの処理後、実行結果のメッセージを取得するまで処理をブロックします。
メッセージの取得後、実行結果内容を保持するExecutionResponseのインスタンスを返します。

このメソッドは、接続にAzure Service Busサービスとの接続に失敗した場合など例外が発生します。
詳細については、「主な例外」を参照してください。

戻り値:
  • 実行結果内容を保持するExecutionResponseインスタンス
public void PutParam(string key, string value)

文字列型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: 文字列型のスクリプト入力変数に渡す値
public void PutParam(string key, int value)

整数型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: 整数型のスクリプト入力変数に渡す値
public void PutParam(string key, decimal value)

10進数型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: 10進数型のスクリプト入力変数に渡す値
public void PutParam(string key, System, DateTime value)

日付/時間型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。
ミリ秒より小さい桁の値は切り捨てられます。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: 日付/時間型のスクリプト入力変数に渡す値
public void PutParam(string key, bool value)

真偽値型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: 真偽値型のスクリプト入力変数に渡す値
public void PutParam(string key, byte[] value)

バイナリ型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: バイナリ型のスクリプト入力変数に渡す値
public void PutParam(string key, System.Xml.XmlDocument value)

XML型のスクリプト入力変数に渡すパラメータを設定します。
このメソッドは、必ずExecuteメソッドより前に呼び出してください。

パラメータ:
  • key: パラメータのキー。値を渡したいスクリプト入力変数名と同じものを指定してください。
  • value: XML型のスクリプト入力変数に渡す値

ExecutionResponse


スクリプトの実行結果を保持するクラスです。
終了ステータスやエラー情報、スクリプト出力変数などをこのクラスから取得することができます。

ExecutionResponse型で公開されるメンバは以下の通りです。

プロパティ
public int ExitStatus

終了ステータスを取得します。
終了ステータスについては、「終了ステータス」を参照してください。
public bool Succeeded

スクリプトの実行に成功したかどうかを取得します。
public Dictionary<string, object> Results

スクリプトの実行に成功した場合、スクリプト出力変数の内容を保持するDictionaryインスタンスを取得します。

戻り値のDictionaryは、スクリプト出力変数名をキーとして、スクリプト出力変数の型に対応するC#の型のインスタンスが値として保持されています。 値を取得する際は、「スクリプト出力変数の値を取得するには」を参照して対象の型にキャストしてください。
public ExecutionFailure Failure

スクリプトの実行に失敗した場合、エラーの内容を保持するExecutionFailureのインスタンスを取得します。

ExecutionFailure


エラー情報を保持するクラスです。

ExecutionFailure型で公開されるメンバは以下の通りです。

プロパティ
public string Type

発生したエラーのタイプを取得します。
public string Message

発生したエラーのメッセージを取得します。
public string Detail

発生したエラーの詳細を取得します。