DurableOrchestrationClientBase.WaitForCompletionOrCreateCheckStatusResponseAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan) |
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) |
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, TimeSpan, TimeSpan) |
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, TimeSpan)
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 virtual System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync(System.Net.Http.HttpRequestMessage request, string instanceId, TimeSpan timeout);abstract member WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string * TimeSpan -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
override this.WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string * TimeSpan -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public Overridable Function WaitForCompletionOrCreateCheckStatusResponseAsync (request As HttpRequestMessage, instanceId As String, timeout As TimeSpan) As Task(Of HttpResponseMessage)Parameters
- request
- System.Net.Http.HttpRequestMessage
The HTTP request that triggered the current function.
- instanceId
- System.String
The unique ID of the instance to check.
- timeout
- System.TimeSpan
Total allowed timeout for output from the durable function. The default value is 10 seconds.
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) API.
Applies to
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String)
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 virtual System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync(System.Net.Http.HttpRequestMessage request, string instanceId);abstract member WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
override this.WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public Overridable Function WaitForCompletionOrCreateCheckStatusResponseAsync (request As HttpRequestMessage, instanceId As String) As Task(Of HttpResponseMessage)Parameters
- request
- System.Net.Http.HttpRequestMessage
The HTTP request that triggered the current function.
- instanceId
- System.String
The unique ID of the instance to check.
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 default 10 second 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 this timeout, then the HTTP response will be identical to that of the CreateCheckStatusResponse(HttpRequestMessage, String) API.
Applies to
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan, TimeSpan)
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 abstract System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync(System.Net.Http.HttpRequestMessage request, string instanceId, TimeSpan timeout, TimeSpan retryInterval);abstract member WaitForCompletionOrCreateCheckStatusResponseAsync : System.Net.Http.HttpRequestMessage * string * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public MustOverride Function WaitForCompletionOrCreateCheckStatusResponseAsync (request As HttpRequestMessage, instanceId As String, timeout As TimeSpan, retryInterval As TimeSpan) As Task(Of HttpResponseMessage)Parameters
- request
- System.Net.Http.HttpRequestMessage
The HTTP request that triggered the current function.
- instanceId
- System.String
The unique ID of the instance to check.
- timeout
- System.TimeSpan
Total allowed timeout for output from the durable function. The default value is 10 seconds.
- retryInterval
- System.TimeSpan
The timeout between checks for output from the durable function. The default value is 1 second.
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) API.