다음을 통해 공유


IDurableOrchestrationClient.WaitForCompletionOrCreateCheckStatusResponseAsync Method

Definition

Overloads

WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequest, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)

Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration.

WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)

Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration.

WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequest, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)

Source:
IDurableOrchestrationClient.cs

Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration.

public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> WaitForCompletionOrCreateCheckStatusResponseAsync (Microsoft.AspNetCore.Http.HttpRequest request, string instanceId, TimeSpan? timeout = default, TimeSpan? retryInterval = default, bool returnInternalServerErrorOnFailure = false);
abstract member WaitForCompletionOrCreateCheckStatusResponseAsync : Microsoft.AspNetCore.Http.HttpRequest * string * Nullable<TimeSpan> * Nullable<TimeSpan> * bool -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
Public Function WaitForCompletionOrCreateCheckStatusResponseAsync (request As HttpRequest, instanceId As String, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional retryInterval As Nullable(Of TimeSpan) = Nothing, Optional returnInternalServerErrorOnFailure As Boolean = false) As Task(Of IActionResult)

Parameters

request
HttpRequest

The HTTP request that triggered the current function.

instanceId
String

The unique ID of the instance to check.

timeout
Nullable<TimeSpan>

Total allowed timeout for output from the durable function. The default value is 10 seconds.

retryInterval
Nullable<TimeSpan>

The timeout between checks for output from the durable function. The default value is 1 second.

returnInternalServerErrorOnFailure
Boolean

Optional parameter that configures the http response code returned. Defaults to false. If true, the returned http response code will be a 500 when the orchestrator is in a failed state, when false it will return 200.

Returns

An HTTP response which may include a 202 and location header or a 200 with the durable function output in the response body.

Remarks

If the orchestration instance completes within the specified timeout, then the HTTP response payload will contain the output of the orchestration instance formatted as JSON. However, if the orchestration does not complete within the specified timeout, then the HTTP response will be identical to that of the CreateCheckStatusResponse(HttpRequest, String, Boolean) API.

Applies to

WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)

Source:
IDurableOrchestrationClient.cs

Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration.

public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync (System.Net.Http.HttpRequestMessage request, string instanceId, TimeSpan? timeout = default, TimeSpan? retryInterval = default, bool returnInternalServerErrorOnFailure = false);
abstract member WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string * Nullable<TimeSpan> * Nullable<TimeSpan> * bool -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
Public Function WaitForCompletionOrCreateCheckStatusResponseAsync (request As HttpRequestMessage, instanceId As String, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional retryInterval As Nullable(Of TimeSpan) = Nothing, Optional returnInternalServerErrorOnFailure As Boolean = false) As Task(Of HttpResponseMessage)

Parameters

request
HttpRequestMessage

The HTTP request that triggered the current function.

instanceId
String

The unique ID of the instance to check.

timeout
Nullable<TimeSpan>

Total allowed timeout for output from the durable function. The default value is 10 seconds.

retryInterval
Nullable<TimeSpan>

The timeout between checks for output from the durable function. The default value is 1 second.

returnInternalServerErrorOnFailure
Boolean

Optional parameter that configures the http response code returned. Defaults to false. If true, the returned http response code will be a 500 when the orchestrator is in a failed state, when false it will return 200.

Returns

An HTTP response which may include a 202 and location header or a 200 with the durable function output in the response body.

Remarks

If the orchestration instance completes within the specified timeout, then the HTTP response payload will contain the output of the orchestration instance formatted as JSON. However, if the orchestration does not complete within the specified timeout, then the HTTP response will be identical to that of the CreateCheckStatusResponse(HttpRequestMessage, String, Boolean) API.

Applies to