Click or drag to resize

TemporalClient Methods

The TemporalClient type exposes the following members.

Methods
  NameDescription
Public methodActivityCompleteByIdAsync
Used to externally complete an activity identified by WorkflowExecution and activity ID.
Public methodActivityCompleteByTokenAsync
Used to externally complete an activity identified by task token.
Public methodActivityErrorByIdAsync
Used to externally fail an activity by WorkflowExecution and activity ID.
Public methodActivityErrorByTokenAsync
Used to externally fail an activity by task token.
Public methodActivityHeartbeatByIdAsync
Used to record an activity heartbeat externally by WorkflowExecution and activity ID.
Public methodActivityHeartbeatByTokenAsync
Used to record an activity heartbeat externally by task token.
Public methodStatic memberBuildActivityStubTActivity
Prebuilds and caches the internal activity stub class backing the TActivity interface. Subsequent calls for the same activity interface can be made but actually do nothing.
Public methodStatic memberBuildAssemblyStubs
Scans the assembly passed for any workflow or activity interfaces and pebuilds and caches the generated internal backing classes. Subsequent calls for the same assembly can be made but actually do nothing.
Public methodStatic memberBuildWorkflowStubTWorkflow
Prebuilds and caches the internal workflow stub class backing the TWorkflow interface. Subsequent calls for the same workflow interface can be made but actually do nothing.
Public methodStatic memberConnectAsync
Establishes a connection to a Temporal cluster.
Public methodDebugLog

INTERNAL USE ONLY: Appends a line of text to the debug log which is used internally to debug generated code like stubs. This hardcodes its output to C:\Temp\temporal-debug.log so this currently only works on Windows.

Note Note
This method doesn't actually log anything unless Debug is set to true.
Public methodDescribeNamespaceAsync
Describes the named Temporal namespace.
Public methodDescribeQueueListAsync
Returns information about pollers (AKA workers) that have communicated with the Temporal cluster in the last few minutes.
Public methodDescribeWorkflowExecutionAsync(WorkflowExecution, String)
Returns the current state of a running workflow.
Public methodDescribeWorkflowExecutionAsync(String, String, String)
Describes a workflow execution by explicit IDs.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases all associated resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberExtractTemporalProxy

Writes the temporal-proxy binaries to the specified folder. This is provided so that you can pre-provision the executable and then use the BinaryPath setting to reference it. These files will be written:

temporal-proxy.win.exe The Windows AMD64 executable
temporal-proxy.linux The Linux AMD64 executable
temporal-proxy.osx The OS/X AMD64 executable

This is useful for situations where the executable must be pre-provisioned for security. One example is deploying Temporal workers to a Docker container with a read-only file system.

Protected methodFinalize
Finalizer.
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWorkflowCacheSizeAsync
Returns the current maximum number of sticky workflows for which history will be retained as a performance optimization.
Public methodListNamespacesAsync
Lists the Temporal namespaces.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewUntypedWorkflowStub(String, StartWorkflowOptions)
Creates an untyped stub that can be used to start a single workflow execution.
Public methodNewUntypedWorkflowStub(WorkflowExecution, String)
Creates an untyped stub for a known workflow execution.
Public methodNewUntypedWorkflowStub(String, String, String)
Creates an untyped stub for a known workflow execution.
Public methodNewWorkerAsync
Creates a new Temporal Worker attached to the current client. You'll use this to register your workflow and/or activity implementations with Temporal and the start the worker to signal Temporal that the worker is ready for business.
Public methodNewWorkflowFutureStubTWorkflowInterface
Creates a stub suitable for starting an external workflow and then waiting for the result as separate operations.
Public methodNewWorkflowStub(String, StartWorkflowOptions)
Creates an untyped workflow stub to be used for launching a workflow.
Public methodNewWorkflowStubTWorkflowInterface(StartWorkflowOptions, String)
Creates a typed workflow stub that can be used to start as well as query and signal the workflow via the type-safe interface methods.
Public methodNewWorkflowStubTWorkflowInterface(WorkflowExecution, String)
Creates a typed workflow stub connected to a known workflow execution using a WorkflowExecution. This can be used to signal and query the workflow via the type-safe interface methods.
Public methodNewWorkflowStubTWorkflowInterface(String, String, String)
Creates a typed workflow stub connected to a known workflow execution using IDs. This can be used to signal and query the workflow via the type-safe interface methods.
Public methodPingAsync
Pings the temporal-proxy and waits for the reply. This is used mainly for low-level performance and load testing but can also be used to explicitly verify that the temporal-proxy is still alive.
Public methodRegisterNamespaceAsync
Registers a Temporal namespace using the specified parameters.
Public methodSetCacheMaximumSizeAsync

Sets the maximum number of sticky workflows for which of history will be retained for workflow workers created by this client as a performance optimization. When this is exceeded, Temporal will may need to retrieve the entire workflow history from the Temporal cluster when a workflow is scheduled on the client's workers.

This defaults to 10K sticky workflows.

Public methodTerminateWorkflowAsync
Terminates a workflow if it has not already finished.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateNamespaceAsync
Updates the named Temporal namespace.
Public methodWaitForWorkflowStartAsync
Waits for a resonable period of time for Temporal to start a workflow.
Top
See Also