 | TemporalClient Methods |
The TemporalClient type exposes the following members.
Methods| Name | Description | |||||||
|---|---|---|---|---|---|---|---|---|
 | ActivityCompleteByIdAsync |
Used to externally complete an activity identified by WorkflowExecution and activity ID.
| ||||||
| ActivityCompleteByTokenAsync |
Used to externally complete an activity identified by task token.
| ||||||
| ActivityErrorByIdAsync |
Used to externally fail an activity by WorkflowExecution and activity ID.
| ||||||
| ActivityErrorByTokenAsync |
Used to externally fail an activity by task token.
| ||||||
| ActivityHeartbeatByIdAsync |
Used to record an activity heartbeat externally by WorkflowExecution and activity ID.
| ||||||
| ActivityHeartbeatByTokenAsync |
Used to record an activity heartbeat externally by task token.
| ||||||
 | BuildActivityStubTActivity |
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.
| ||||||
| BuildAssemblyStubs |
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.
| ||||||
| BuildWorkflowStubTWorkflow |
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.
| ||||||
| ConnectAsync |
Establishes a connection to a Temporal cluster.
| ||||||
| DebugLog | 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.
| ||||||
| DescribeNamespaceAsync |
Describes the named Temporal namespace.
| ||||||
| DescribeNamespaceByIdAsync |
Describes a Temporal namespace by UUID.
| ||||||
| DescribeQueueListAsync |
Returns information about pollers (AKA workers) that have communicated
with the Temporal cluster in the last few minutes.
| ||||||
| DescribeWorkflowExecutionAsync(WorkflowExecution, String) |
Returns the current state of a running workflow.
| ||||||
| DescribeWorkflowExecutionAsync(String, String, String) |
Describes a workflow execution by explicit IDs.
| ||||||
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | ||||||
 | Dispose(Boolean) |
Releases all associated resources.
| ||||||
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | ||||||
| ExtractTemporalProxy | 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:
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. | ||||||
| Finalize |
Finalizer.
(Overrides ObjectFinalize.) | ||||||
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | ||||||
| GetType | Gets the Type of the current instance. (Inherited from Object.) | ||||||
| GetWorkflowCacheSizeAsync |
Returns the current maximum number of sticky workflows for which history
will be retained as a performance optimization.
| ||||||
| ListNamespacesAsync |
Lists the Temporal namespaces.
| ||||||
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | ||||||
| NewUntypedWorkflowStub(String, WorkflowOptions) |
Creates an untyped stub that can be used to start a single workflow execution.
| ||||||
| NewUntypedWorkflowStub(WorkflowExecution, String) |
Creates an untyped stub for a known workflow execution.
| ||||||
| NewUntypedWorkflowStub(String, String, String) |
Creates an untyped stub for a known workflow execution.
| ||||||
| NewWorkerAsync |
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.
| ||||||
| NewWorkflowFutureStubTWorkflowInterface |
Creates a stub suitable for starting an external workflow and then waiting
for the result as separate operations.
| ||||||
| NewWorkflowStub(String, WorkflowOptions) |
Creates an untyped workflow stub to be used for launching a workflow.
| ||||||
| NewWorkflowStubTWorkflowInterface(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.
| ||||||
| NewWorkflowStubTWorkflowInterface(WorkflowOptions, 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.
| ||||||
| NewWorkflowStubTWorkflowInterface(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.
| ||||||
| PingAsync |
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.
| ||||||
| RegisterNamespaceAsync |
Registers a Temporal namespace using the specified parameters.
| ||||||
| SetCacheMaximumSizeAsync | 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. | ||||||
| TerminateWorkflowAsync |
Terminates a workflow if it has not already finished.
| ||||||
| ToString | Returns a string that represents the current object. (Inherited from Object.) | ||||||
| UpdateNamespaceAsync |
Updates the named Temporal namespace.
| ||||||
| WaitForWorkflowStartAsync |
Waits for a resonable period of time for Temporal to start a workflow.
|
NoteSee Also