Class NexusClient

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Client for making Nexus service calls from a workflow.

public abstract class NexusClient

Inheritance

object

NexusClient

Derived

NexusClient<TService>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Nexus support is experimental.

Properties

Options

Gets the client options. Should not be mutated.

public abstract NexusClientOptions Options { get; }

Property Value

NexusClientOptions

Service

Gets the service name.

public abstract string Service { get; }

Property Value

string

Methods

ExecuteNexusOperationAsync(string, object?, NexusOperationOptions?)

Shortcut for StartNexusOperationAsync(string, object?, NexusOperationOptions?) + GetResultAsync().

public Task ExecuteNexusOperationAsync(string operationName, object? arg, NexusOperationOptions? options = null)

Parameters

operationName string

Operation name to start.

arg object

Operation argument.

options NexusOperationOptions

Operation options.

Returns

Task

Task representing completion of the Nexus operation.

ExecuteNexusOperationAsync<TResult>(string, object?, NexusOperationOptions?)

Shortcut for StartNexusOperationAsync<TResult>(string, object?, NexusOperationOptions?) + GetResultAsync().

public Task<TResult> ExecuteNexusOperationAsync<TResult>(string operationName, object? arg, NexusOperationOptions? options = null)

Parameters

operationName string

Operation name to start.

arg object

Operation argument.

options NexusOperationOptions

Operation options.

Returns

Task<TResult>

Task with the result of the Nexus operation.

Type Parameters

TResult

Operation result type.

StartNexusOperationAsync(string, object?, NexusOperationOptions?)

Start a Nexus operation by name.

public Task<NexusOperationHandle> StartNexusOperationAsync(string operationName, object? arg, NexusOperationOptions? options = null)

Parameters

operationName string

Operation name to start.

arg object

Operation argument.

options NexusOperationOptions

Operation options.

Returns

Task<NexusOperationHandle>

Handle to the started operation once started.

StartNexusOperationAsync<TResult>(string, object?, NexusOperationOptions?)

Start a Nexus operation by name with specific expected result type.

public abstract Task<NexusOperationHandle<TResult>> StartNexusOperationAsync<TResult>(string operationName, object? arg, NexusOperationOptions? options = null)

Parameters

operationName string

Operation name to start.

arg object

Operation argument.

options NexusOperationOptions

Operation options.

Returns

Task<NexusOperationHandle<TResult>>

Handle to the started operation once started.

Type Parameters

TResult

Operation result type.