DurableClient class
オーケストレーションおよびエンティティ インスタンスに対するイベントの開始、クエリ、終了、および発生のためのクライアント。
プロパティ
| task |
このオーケストレーション クライアント インスタンスで構成されたタスク ハブの名前。 |
メソッド
| create |
指定したインスタンスの状態を確認するのに役立つ HTTP 応答を作成します。 |
| create |
インスタンス管理 HTTP エンドポイントを含む HttpManagementPayload オブジェクトを作成します。 |
| get |
指定したオーケストレーション インスタンスの状態を取得します。 |
| get |
すべてのオーケストレーション インスタンスの状態を取得します。 |
| get |
指定した条件に一致するすべてのオーケストレーション インスタンスの状態を取得します。 |
| purge |
特定のオーケストレーション インスタンスの履歴を消去します。 |
| purge |
条件に一致するインスタンスのオーケストレーション履歴を消去します。 |
| raise |
待機中のオーケストレーション インスタンスにイベント通知メッセージを送信します。 |
| read |
エンティティの現在の状態の読み取りを試みます。 エンティティが存在しない場合、またはエンティティの JSON シリアル化された状態が 16 KB を超える場合は undefined を返します。 |
| rewind(string, string, Task |
指定した失敗したオーケストレーション インスタンスを理由で巻き戻します。 |
| signal |
操作を実行するようにエンティティに通知します。 |
| start |
指定したオーケストレーター関数の新しいインスタンスを開始します。 指定した ID を持つオーケストレーション インスタンスが既に存在する場合、既存のインスタンスはこの新しいインスタンスに自動的に置き換えられます。 |
| terminate(string, string) | 実行中のオーケストレーション インスタンスを終了します。 |
| wait |
完了していないインスタンスの管理 URL のペイロードを含む、または完了したオーケストレーションの出力を含むペイロードを含む HTTP 応答を作成します。 指定したタイムアウト内にオーケストレーションが完了しない場合、HTTP 応答は createCheckStatusResponse() の応答と同じになります。 |
プロパティの詳細
taskHubName
このオーケストレーション クライアント インスタンスで構成されたタスク ハブの名前。
taskHubName: stringプロパティ値
string
メソッドの詳細
createCheckStatusResponse(undefined | HttpRequest, string)
指定したインスタンスの状態を確認するのに役立つ HTTP 応答を作成します。
function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponseパラメーター
- request
-
undefined | HttpRequest
現在のオーケストレーション インスタンスをトリガーした HTTP 要求。
- instanceId
-
string
確認するオーケストレーション インスタンスの ID。
戻り値
Location ヘッダーと、インスタンス管理 URL を含むペイロードを含む HTTP 202 応答。
createHttpManagementPayload(string)
インスタンス管理 HTTP エンドポイントを含む HttpManagementPayload オブジェクトを作成します。
function createHttpManagementPayload(instanceId: string): HttpManagementPayloadパラメーター
- instanceId
-
string
確認するオーケストレーション インスタンスの ID。
戻り値
getStatus(string, GetStatusOptions)
指定したオーケストレーション インスタンスの状態を取得します。
function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>パラメーター
- instanceId
-
string
クエリを実行するオーケストレーション インスタンスの ID。
- options
- GetStatusOptions
追加の構成を指定する options オブジェクト
戻り値
Promise<DurableOrchestrationStatus>
getStatusAll()
すべてのオーケストレーション インスタンスの状態を取得します。
function getStatusAll(): Promise<DurableOrchestrationStatus[]>戻り値
Promise<DurableOrchestrationStatus[]>
getStatusBy(OrchestrationFilter)
指定した条件に一致するすべてのオーケストレーション インスタンスの状態を取得します。
function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>パラメーター
- filter
- OrchestrationFilter
取得するオーケストレーションを指定する OrchestrationFilter オブジェクト。
戻り値
Promise<DurableOrchestrationStatus[]>
purgeInstanceHistory(string)
特定のオーケストレーション インスタンスの履歴を消去します。
function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>パラメーター
- instanceId
-
string
消去するオーケストレーション インスタンスの ID。
戻り値
Promise<PurgeHistoryResult>
purgeInstanceHistoryBy(OrchestrationFilter)
条件に一致するインスタンスのオーケストレーション履歴を消去します。
function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>パラメーター
- filter
- OrchestrationFilter
消去するオーケストレーションを指定する OrchestrationFilter オブジェクト。
戻り値
Promise<PurgeHistoryResult>
raiseEvent(string, string, unknown, TaskHubOptions)
待機中のオーケストレーション インスタンスにイベント通知メッセージを送信します。
function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>パラメーター
- instanceId
-
string
イベントを処理するオーケストレーション インスタンスの ID。
- eventName
-
string
イベントの名前。
- eventData
-
unknown
イベントに関連付けられた JSON シリアル化可能なデータ。
- options
- TaskHubOptions
オーケストレーション インスタンスの TaskHubName とそれに関連付けられている接続文字列の名前を提供するオブジェクト
戻り値
Promise<void>
イベント通知メッセージがエンキューされたときに解決される Promise。
イベントを処理するには、ターゲット オーケストレーション インスタンスが waitForExternalEvent(string)を使用して eventName という名前のイベントを待機している必要があります。
指定したインスタンスが見つからないか、実行されていない場合、この操作は無効になります。
readEntityState<T>(EntityId, TaskHubOptions)
エンティティの現在の状態の読み取りを試みます。 エンティティが存在しない場合、またはエンティティの JSON シリアル化された状態が 16 KB を超える場合は undefined を返します。
function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>パラメーター
- entityId
- EntityId
ターゲット エンティティ。
- options
- TaskHubOptions
ターゲット エンティティの TaskHubName とそれに関連付けられている接続文字列の名前を提供する省略可能なオブジェクト
戻り値
Promise<EntityStateResponse<T>>
エンティティの現在の状態を含む応答。
rewind(string, string, TaskHubOptions)
指定した失敗したオーケストレーション インスタンスを理由で巻き戻します。
function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>パラメーター
- instanceId
-
string
巻き戻すオーケストレーション インスタンスの ID。
- reason
-
string
オーケストレーション インスタンスを巻き戻す理由。
- options
- TaskHubOptions
オーケストレーション インスタンスの TaskHubName とそれに関連付けられている接続文字列の名前を提供するオブジェクト
戻り値
Promise<void>
巻き戻しメッセージがエンキューされたときに解決される Promise。
この機能は現在プレビュー段階です。
signalEntity(EntityId, string, unknown, TaskHubOptions)
操作を実行するようにエンティティに通知します。
function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>パラメーター
- entityId
- EntityId
ターゲット エンティティ。
- operationName
-
string
操作の名前。
- operationContent
-
unknown
操作の内容。
- options
- TaskHubOptions
エンティティ インスタンスの TaskHubName とそれに関連付けられている接続文字列の名前を提供するオブジェクト
戻り値
Promise<void>
startNew(string, StartNewOptions)
指定したオーケストレーター関数の新しいインスタンスを開始します。
指定した ID を持つオーケストレーション インスタンスが既に存在する場合、既存のインスタンスはこの新しいインスタンスに自動的に置き換えられます。
function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>パラメーター
- orchestratorFunctionName
-
string
開始するオーケストレーター関数の名前。
- options
- StartNewOptions
スケジュールされたオーケストレーターを制御する省略可能なオブジェクト (入力の提供、instanceID など)
戻り値
Promise<string>
新しいオーケストレーション インスタンスの ID。
terminate(string, string)
実行中のオーケストレーション インスタンスを終了します。
function terminate(instanceId: string, reason: string): Promise<void>パラメーター
- instanceId
-
string
終了するオーケストレーション インスタンスの ID。
- reason
-
string
オーケストレーション インスタンスを終了する理由。
戻り値
Promise<void>
終了メッセージがエンキューされたときに解決される Promise。
オーケストレーション インスタンスを終了しても、現在のオーケストレーション インスタンスによって開始された実行中のアクティビティ関数の実行やサブオーケストレーションには影響しません。
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)
完了していないインスタンスの管理 URL のペイロードを含む、または完了したオーケストレーションの出力を含むペイロードを含む HTTP 応答を作成します。
指定したタイムアウト内にオーケストレーションが完了しない場合、HTTP 応答は createCheckStatusResponse() の応答と同じになります。
function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>パラメーター
- request
- HttpRequest
現在の関数をトリガーした HTTP 要求。
- instanceId
-
string
確認するインスタンスの一意の ID。
- waitOptions
- WaitForCompletionOptions
durable 関数からの出力を待機する時間と出力をチェックする頻度のタイムアウトを指定する options オブジェクト。
戻り値
Promise<HttpResponse>