Class WithStartWorkflowOperation<THandle>

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Representation of a workflow start operation to be used in WorkflowStartUpdateWithStartOptions and WorkflowUpdateWithStartOptions for update with start calls.

public sealed class WithStartWorkflowOperation<THandle> : WithStartWorkflowOperation, ICloneable where THandle : WorkflowHandle

Type Parameters

THandle

Workflow handle type.

Inheritance

object

WithStartWorkflowOperation

WithStartWorkflowOperation<THandle>

Implements

ICloneable

Inherited Members

WithStartWorkflowOperation.Workflow

WithStartWorkflowOperation.Args

WithStartWorkflowOperation.Options

WithStartWorkflowOperation.Headers

WithStartWorkflowOperation.Create<TWorkflow, TResult>(Expression<Func<TWorkflow, Task<TResult>>>, WorkflowOptions)

WithStartWorkflowOperation.Create<TWorkflow>(Expression<Func<TWorkflow, Task>>, WorkflowOptions)

WithStartWorkflowOperation.Create(string, IReadOnlyCollection<object>, WorkflowOptions)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Workflow update with start is experimental and APIs may change.

Methods

Clone()

Create a shallow copy of this operation.

public override object Clone()

Returns

object

A shallow copy of these options and any transitive options fields. But it will not clone the arguments, headers, nor will it clone the underlying promise that is fulfilled when the workflow has started.

GetHandleAsync()

Get the started workflow handle, waiting if needed. The method call directly will never fail, but the task may with exceptions documented below.

public Task<THandle> GetHandleAsync()

Returns

Task<THandle>

Task for the successfully completed handle.

Remarks

WARNING: Workflow update with start is experimental and APIs may change.

Exceptions

ArgumentException

Invalid run call or options.

WorkflowAlreadyStartedException

Workflow was already started according to ID reuse and conflict policy.

RpcException

Server-side error.