IOrchestrationSubmitter.ScheduleNewOrchestrationInstanceAsync 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.
Schedules a new orchestration instance for execution. This is an internal API that supports the DurableTask infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new DurableTask release.
public System.Threading.Tasks.Task<string> ScheduleNewOrchestrationInstanceAsync (Microsoft.DurableTask.TaskName orchestratorName, object? input = default, Microsoft.DurableTask.StartOrchestrationOptions? options = default, System.Threading.CancellationToken cancellation = default);abstract member ScheduleNewOrchestrationInstanceAsync : Microsoft.DurableTask.TaskName * obj * Microsoft.DurableTask.StartOrchestrationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Function ScheduleNewOrchestrationInstanceAsync (orchestratorName As TaskName, Optional input As Object = Nothing, Optional options As StartOrchestrationOptions = Nothing, Optional cancellation As CancellationToken = Nothing) As Task(Of String)Parameters
- orchestratorName
- TaskName
The name of the orchestrator to schedule.
- input
- Object
The optional input to pass to the scheduled orchestration instance. This must be a serializable value.
- options
- StartOrchestrationOptions
The options to start the new orchestration with.
- cancellation
- CancellationToken
The cancellation token. This only cancels enqueueing the new orchestration to the backend. Does not cancel the orchestration once enqueued.
Returns
A task that completes when the orchestration instance is successfully scheduled. The value of this task is
the instance ID of the scheduled orchestration instance. If a non-null instance ID was provided via
options, the same value will be returned by the completed task.