![]() | Neon.Cadence Namespace |
Class | Description | |||||
---|---|---|---|---|---|---|
![]() | AccessDeniedException |
Thrown when an operation cannot be performed to access limits.
| ||||
![]() | Activity |
Provides useful information and functionality for workflow implementations.
This will be available via the Workflow property.
| ||||
![]() | ActivityAttribute |
Used to tag activity implementations that inherit from
ActivityBase to customize the how the activity is
registered.
| ||||
![]() | ActivityBase |
Base class that must be inherited by all implementations.
| ||||
![]() | ActivityFutureStub |
Used to execute an untyped activity in parallel with other activities, child
workflows or other operations. Instances are created via
NewActivityFutureStub(String, ActivityOptions).
| ||||
![]() | ActivityFutureStubTActivityInterface |
Used to execute a typed activity in parallel with other activities, child
workflows or other operations. Instances are created via
NewActivityFutureStubTActivityInterface(String, ActivityOptions).
| ||||
![]() | ActivityHeartbeatTimeoutException |
Thrown when an activity did not send a timely heartbeat to Cadence.
| ||||
![]() | ActivityInterfaceAttribute |
Used to tag activity interfaces and optionally specify the task list
identifying the workers hosting this activity. CadenceClient
for more information on how task lists work.
| ||||
![]() | ActivityMethodAttribute |
Used to customize activity interface method options.
| ||||
![]() | ActivityOptions |
Specifies the options used for executing an activity.
| ||||
![]() | ActivityStub |
Used to execute an untyped activity whose .NET type information is not known
at runtime or an activity written in different languages.
| ||||
![]() | ActivityTask |
Holds information about an executing activity.
| ||||
![]() | ActivityTypeException |
Thrown when ak activity interface or implementation is not valid.
| ||||
![]() | ActivityWorkerStartedException |
Thrown when an attempt is made to register an activity implementation after an
activity worker has been started on a client. You must register all implementations
before starting a worker.
| ||||
![]() | BadRequestException |
Thrown when a Cadence receives an invalid request.
| ||||
![]() | CadenceClient |
Implements a client that will be connected to a Cadence cluster and be used
to create and manage workflows.
| ||||
![]() | CadenceClientClosedArgs |
The event arguments sent when a CadenceClient is closed
with a property indicating whether or not the connection was closed due
to an error.
| ||||
![]() | CadenceCustomException |
Thrown when a Cadence custom error is encountered.
| ||||
![]() | CadenceException |
Base class for all Cadence related exceptions.
| ||||
![]() | CadenceGenericException |
Thrown when a Cadence generic error is encountered.
| ||||
![]() | CadenceInternalException |
Base class for Cadence exceptions that must not be caught and handled
by workflow entry point methods. The Cadence client must be allowed
to handle these.
| ||||
![]() | CadencePanicException |
Thrown when a Cadence panic error is encountered.
| ||||
![]() | CadenceSettings |
Cadence client settings.
| ||||
![]() | CadenceTimeoutException |
Indicates that a Cadence operation timed out.
| ||||
![]() | CancellationAlreadyRequestedException |
Thrown when attempting to cancel an operation that has already been cancelled.
| ||||
![]() | CancelledException |
Thrown when a Cadence operation is cancelled.
| ||||
![]() | ChildWorkflowFuture |
Implements a child workflow future that returns void.
| ||||
![]() | ChildWorkflowFutureTResult |
Implements a child workflow future that returns a value.
| ||||
![]() | ChildWorkflowFutureStub | Manages starting and signalling a child workflow instance based on its workflow type name and arguments. This is useful when you need to perform other operations in parallel with a child by separating workflow execution and retrieving the result into separate operations. Use this version for workflows that don't return a result. | ||||
![]() | ChildWorkflowOptions |
Specifies the options to use when executing a child workflow.
| ||||
![]() | ChildWorkflowStubTWorkflowInterface |
Used to execute a child workflow in parallel with other child workflows or activities.
Instances are created via NewChildWorkflowFutureStubTWorkflowInterface(String, ChildWorkflowOptions).
| ||||
![]() | ClientVersionNotSupportedException |
Thrown when the underlying GOLANG client version is not supported by the Cadence cluster.
| ||||
![]() | ConnectException |
Thrown when a Cadence connection could not be established.
| ||||
![]() | ContinueAsNewException | INTERNAL USE ONLY: Thrown by ContinueAsNewAsync(ContinueAsNewOptions, Object)
or ContinueAsNewAsync(Object) as well as any continue-as-new stubs to be handled
internally by WorkflowBase.
| ||||
![]() | ContinueAsNewOptions |
Specifies the options to be used when continuing a workflow as a
new instance.
| ||||
![]() | DomainAlreadyExistsException |
Thrown when a Cadence domain already exists.
| ||||
![]() | DomainConfiguration |
Domain configuration options.
| ||||
![]() | DomainDescription |
Information returned by DescribeDomainAsync(String).
| ||||
![]() | DomainInfo |
Information about a Cadence domain.
| ||||
![]() | DomainListPage |
Holds a page of domain information listed from Cadence.
| ||||
![]() | DomainNotActiveException |
Thrown when a Cadence domain has been deprecated.
| ||||
![]() | EntityNotExistsException |
Thrown when a Cadence request references an entity that doesn't exist.
| ||||
![]() | ExternalWorkflowFuture |
Implements an external workflow future that returns void.
| ||||
![]() | ExternalWorkflowFutureTResult |
Implements an external workflow future that returns a value.
| ||||
![]() | ExternalWorkflowStub |
Supports signalling and cancelling any workflow. This is useful when an
external workflow interface type is not known at compile time or to manage
workflows written in another language.
| ||||
![]() | InternalServiceException |
Thrown when a Cadence experienced an internal error.
| ||||
![]() | JsonDataConverter | Implements IDataConverter by serializing data to/from UTF-8 encoded JSON text.
| ||||
![]() | LimitExceededException |
Thrown when a Cadence workflow query failed.
| ||||
![]() | LocalActivityFutureStubTActivityInterface, TActivityImplementation |
Used to execute a local activity in parallel with other activities or child workflows.
Instances are created via NewLocalActivityStubTActivityInterface, TActivityImplementation(LocalActivityOptions).
| ||||
![]() | LocalActivityOptions |
Specifies options used when running a local workflow activity.
| ||||
![]() | NonRetriableErrors |
Used in conjunction with RetryOptions to specify errors that
will not cause a workflow related operation to be retried.
| ||||
![]() | PendingActivityInfo |
Describes the current state of a scheduled or executing activity.
| ||||
![]() | PendingChildExecutionInfo |
Decribes the current state of a pending; child workflow.
| ||||
![]() | PollerInfo |
Describes the status of a poller (AKA worker) listening to a task list.
| ||||
![]() | QueryFailedException |
Thrown when a Cadence workflow query failed.
| ||||
![]() | QueryMethodAttribute |
Used to identify a workflow interface method as a query.
| ||||
![]() | RetryOptions |
Describes a Cadence retry policy.
| ||||
![]() | RetryTaskException |
Thrown when a workflow task could not be retried.
| ||||
![]() | ServiceBusyException |
Thrown when the Cadence cluster is too busy to perform an operation.
| ||||
![]() | SignalMethodAttribute |
Used to identify a workflow interface methods as a signal.
| ||||
![]() | SignalRequest | EXPERIMENTAL: Used to relay a received synchronous signal's arguments to the workflow logic via a WorkflowQueueT allowing the workflow handle the signal by executing activities, child workflows, etc. This class also provides a way for the workflow to specify the signal reply. This non-generic version of the class is intended for signals that return void. Use SignalRequestTResult for signals that return a result.
| ||||
![]() | SignalRequestTResult | EXPERIMENTAL: Used to relay a received synchronous signal's arguments to the workflow logic via a WorkflowQueueT allowing the workflow handle the signal by executing activities, child workflows, etc. This class also provides a way for the workflow to specify the signal reply. This generic version of the class is intended for signals that return results. Use SignalRequest for signals that return void.
| ||||
![]() | StartToCloseTimeoutException |
Thrown when a workflow or activity did not complete within the required time.
| ||||
![]() | StubCompilerException |
Thrown when there's a problem compiling a workflow or activity stub.
| ||||
![]() | SyncSignalException |
Thrown when a synchronous signal sent to a workflow fails.
| ||||
![]() | TaskListDescription |
Describes the current status of a Cadence task list.
| ||||
![]() | TerminatedException |
Thrown when a Cadence terminated error is encountered.
| ||||
![]() | UntypedChildWorkflowFutureStubTResult | Manages starting and signalling a child workflow instance based on its workflow type name and arguments. This is useful when you need to perform other operations in parallel with a child. Use this version for workflows that return a result. | ||||
![]() | UpdateDomainInfo |
Holds the changes to be made to a Cadence domain's basic properties.
| ||||
![]() | UpdateDomainRequest |
Holds the changes to be made to a Cadence domain.
| ||||
![]() | WaitForSignalReplyException | EXPERIMENTAL: Thrown by workflow synchronous signal methods when the signal has been marshalled to the workflow method via a WorkflowQueueT and the workflow method will handle the signal reply.
| ||||
![]() | Worker |
Manages a Cadence activity/workflow worker.
| ||||
![]() | WorkerArgs |
Holds the opaque arguments passed to WorkflowBase and ActivityBase
implementations by the CadenceClient when the workflow or activity is
executed on a worker. This must be passed to the base WorkflowBase or
ActivityBase class constructors.
| ||||
![]() | WorkerOptions |
Specifies the options Cadence will use when assigning workflow and activity
executions to a user worker service.
| ||||
![]() | Workflow |
Provides useful information and functionality for workflow implementations.
This will be available via the Workflow property.
| ||||
![]() | WorkflowAttribute |
Used to tag workflow implementations that inherit from
WorkflowBase to customize the how the workflow is
registered.
| ||||
![]() | WorkflowBase |
Base class that must be inherited for all workflow implementations.
| ||||
![]() | WorkflowConfig |
Describes a workflow's configuration.
| ||||
![]() | WorkflowDescription |
Describes a workflow execution.
| ||||
![]() | WorkflowExecution |
Describes the state of an executed workflow.
| ||||
![]() | WorkflowExecutionAlreadyStartedException |
Thrown when attempting to cancel an operation that has already been cancelled.
| ||||
![]() | WorkflowFutureStubWorkflowInterface | Manages starting, signalling, or querying an external workflow instance based on its workflow type name and arguments. This class separates workflow execution and retrieving the result into separate operations. Use this version for workflows that don't return a result. | ||||
![]() | WorkflowInfo |
Returns information about an executing workflow.
| ||||
![]() | WorkflowInterfaceAttribute |
Used to tag workflow interfaces and optionally specify the task list
identifying the workers hosting this workflow. CadenceClient
for more information on how task lists work.
| ||||
![]() | WorkflowMethodAttribute |
Used to identify a workflow interface method as a workflow entry point.
| ||||
![]() | WorkflowOptions |
Specifies the options to use when starting a workflow.
| ||||
![]() | WorkflowParallelOperationException |
Thrown when an operation is requested on an executing workflow while
another operation is already pending. Workflows cannot have multiple
operations running in parallel because this will likely break
workflow determinism.
| ||||
![]() | WorkflowQueueT |
Implements a workflow-safe first-in-first-out (FIFO) queue that can be used by
workflow signal methods to communicate with the running workflow logic.
| ||||
![]() | WorkflowQueueClosedException |
Indicates that a Cadence DequeueAsync(TimeSpan) operation
failed because the queue has been closed.
| ||||
![]() | WorkflowRunningException |
Thrown when a workflow cannot be started because another workflow with
the same ID is already running.
| ||||
![]() | WorkflowStatus |
Describes the current state of a workflow.
| ||||
![]() | WorkflowStub |
Implements an untyped client side stub to a single external workflow instance. This can
be used to invoke, signal, query, and cancel a workflow when the actual workflow
interface isn't available.
| ||||
![]() | WorkflowTypeException |
Thrown when ak workflow interface or implementation is not valid.
| ||||
![]() | WorkflowWorkerStartedException |
Thrown when an attempt is made to register a workflow implementation after an
workflow worker has been started on a client. You must register all implementations
before starting a worker.
|
Interface | Description | |
---|---|---|
![]() | IActivity |
All activity interfaces must derive from this interface.
|
![]() | IDataConverter |
Used by Worker instances to manage serialization of method parameters and results
for workflow and activity methods to/from byte arrays for persistence in the Cadence cluster
database.
|
![]() | IWorkflow |
All workflow interfaces must derive from this interface.
|
Delegate | Description | |
---|---|---|
![]() | CadenceClosedDelegate |
Delegate called by a CadenceClient when the connection is closed
explicitly or where there's a problem communicating with the cadence-proxy.
|
Enumeration | Description | |
---|---|---|
![]() | ActivityStatus |
Enumerates the state of an activity.
|
![]() | ArchivalStatus |
Controls archival.
|
![]() | DomainStatus |
Indicates a Cadence domain status.
|
![]() | NonDeterministicPolicy |
Enumerates how a decision task handler deals with mismatched history events
(presumably arising from non-deterministic workflow definitions).
|
![]() | ParentClosePolicy |
Enumerates the possible child workflow behaviors when the parent
workflow is closed.
|
![]() | TaskListKind |
Enumerates the different kinds of task lists.
|
![]() | TaskListType |
Used to distinguish between decision (AKA workflow) and activity task lists.
|
![]() | WorkflowExecutionCloseStatus |
Enumerates the possible reasons why a workflow was closed.
|
![]() | WorkflowIdReusePolicy |
Enumerates the workflow ID reuse policies.
|