![]() | TemporalSettings Class |
Temporal client settings.
![]() |
---|
Temporal settings properties are considered to be read/write until they are used for connecting a TemporalClient. After that time, these properties are considered read-only and an InvalidOperationException will be thrown when you try to set a property value. |
Namespace: Neon.Temporal
The TemporalSettings type exposes the following members.
Name | Description | |
---|---|---|
![]() | TemporalSettings |
Constructor.
|
Name | Description | |||||
---|---|---|---|---|---|---|
![]() | ActivityHeartbeatTimeoutSeconds |
Specifies the default maximum allowed between activity heartbeats. Activities that
don't submit heartbeats within the time will be considered to be unhealthy and will
be terminated. This defaults to 60 seconds.
| ||||
![]() | ActivityScheduleToCloseTimeoutSeconds |
Specifies the default maximum time an activity is allowed to wait after being
scheduled until it's actually scheduled to execute on a worker. This defaults
to 24 hours.
| ||||
![]() | ActivityScheduleToStartTimeoutSeconds |
Specifies the default maximum time an activity may wait to be started after being scheduled.
This defaults to 24 hours.
| ||||
![]() | ActivityStartToCloseTimeoutSeconds |
Specifies the default maximum time an activity may run after being started.
This defaults to 24 hours.
| ||||
![]() | BinaryFolder |
Optionally specifies the folder where the embedded temporal-proxy binary
will be written before starting it. This defaults to null which specifies
that the binary will be written to the same folder where the Neon.Temporal
assembly resides. This folder may not be writable by the current user so this
allows you to specify an alternative folder.
| ||||
![]() | BinaryPath | Optionally specifies the path to the temporal-proxy executable file. This file must already be present on disk when a TemporalClient connection is established and the appropriate execute permissions must be set for Linux and OS/X. This property takes presidence over BinaryFolder when set. 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.
| ||||
![]() | ClientIdentity |
Optionally identifies the client application establishing the connection so that
Temporal may include this in its logs and metrics. This defaults to "unknown".
| ||||
![]() | ClientTimeoutSeconds |
Optionally specifies the maximum time the client should wait for synchronous
operations to complete. This defaults to 10 seconds.
| ||||
![]() | ConnectRetries |
Specifies the number of times to retry connecting to the Temporal cluster. This defaults
to 3.
| ||||
![]() | ConnectRetryDelaySeconds |
Specifies the number of seconds to delay between cluster connection attempts.
This defaults to 5.0 seconds.
| ||||
![]() | CreateNamespace | Optionally create the Namespace if it doesn't already exist. This defaults to false.
| ||||
![]() | Debug |
Optionally specifies that the connection should run in DEBUG mode. This currently
launches the temporal-proxy with a command window (on Windows only) to make
it easier to see any output it generates and also has temporal-proxy. This
defaults to false.
| ||||
![]() | DebugDisableHandshakes | INTERNAL USE ONLY: Optionally indicates that the temporal-client
will not perform the InitializeRequest/InitializeReply
and TerminateRequest/TerminateReply handshakes
with the temporal-proxy for debugging purposes. This defaults to
false.
| ||||
![]() | DebugDisableHeartbeats | INTERNAL USE ONLY: Optionally disable health heartbeats. This can be
useful while debugging the client but should never be set for production.
This defaults to false.
| ||||
![]() | DebugHttpTimeout | INTERNAL USE ONLY: Optionally specifies the timeout to use for
HTTP requests made to the temporal-proxy. This defaults to
5 seconds.
| ||||
![]() | DebugIgnoreHeartbeats | INTERNAL USE ONLY: Optionally disables heartbeat handling by the
emulated temporal-proxy for testing purposes.
| ||||
![]() | DebugIgnoreTimeouts | INTERNAL USE ONLY: Optionally ignore operation timeouts. This can be
useful while debugging the client but should never be set for production.
This defaults to false.
| ||||
![]() | DebugPrelaunched | INTERNAL USE ONLY: Optionally indicates that the temporal-proxy will
already be running for debugging purposes. When this is true, the
temporal-client be hardcoded to listen on 127.0.0.1:5001 and
the temporal-proxy will be assumed to be listening on 127.0.0.1:5000.
This defaults to false. | ||||
![]() | DefaultTaskQueue |
Specifies the default Temporal task queue for this client. This is optional and defaults to null.
| ||||
![]() | HeartbeatIntervalSeconds |
Optionally specifies the interval at which heartbeats are transmitted to
temporal-proxy as a health check. This defaults to 5 seconds.
| ||||
![]() | HeartbeatTimeoutSeconds |
Optionally specifies the maximum time to allow the temporal-proxy
to respond to a heartbeat message. The proxy will be considered to be
unhealthy when this happens. This defaults to 5 seconds.
| ||||
![]() | HostPort |
Specifies the Temporal server host and port being connected. This is typically formatted
as host:port where host is the IP address or hostname for the
Temporal server. Alternatively, this can be formatted as dns:///host:port
to enable DNS round-robin lookups. This defaults to localhost:7233.
| ||||
![]() | ListenPort |
Optionally specifies the port where the client will listen for traffic from the
associated temporal-proxy. This defaults to 0 which specifies that lets the
operating system choose an unused ephermal port.
| ||||
![]() | LogDuringReplay |
Optionally enable workflow logging while the workflow is being
replayed from history. This should generally be enabled only
while debugging. This defaults to false.
| ||||
![]() | LogTemporal | Optionally specifies that low-level log messages from the embedded GOLANG Temporal client will be included in the log output. This defaults to false.
| ||||
![]() | LogTemporalProxy | Optionally specifies that log messages from the internal temporal-proxy code that bridges between .NET and the embedded GOLANG Temporal client will be included in the log output. This defaults to false.
| ||||
![]() | MaxWorkflowKeepAliveSeconds | EXPERIMENTAL: Specifies the maximum seconds that a workflow will be kept alive after
the workflow method returns to handle any oustanding synchronous signal queries. This defaults
to 30.0 seconds.
| ||||
![]() | MaxWorkflowWaitUntilRunningSeconds |
The default maximum time the WaitForWorkflowStartAsync(WorkflowExecution, String, NullableTimeSpan) method
will wait for a workflow to start. This defaults to 30.0 seconds.
| ||||
![]() | Namespace |
Specifies the default Temporal namespace for this client. This is required and defaults to "default".
| ||||
![]() | ProxyLogLevel | |||||
![]() | ProxyTimeoutSeconds |
Optionally specifies the maximum time to allow the temporal-proxy
to indicate that it has received a proxy request message by returning an
OK response. The proxy will be considered to be unhealthy when this
happens. This defaults to 5 seconds.
| ||||
![]() | SecurityToken | The Temporal cluster security token. This defaults to null.
| ||||
![]() | WorkflowDecisionTaskTimeoutSeconds |
Specifies the default maximum time a workflow decision task may execute.
This must be with the range of 1 < value <= 60 seconds.
This defaults to 10 seconds.
| ||||
![]() | WorkflowIdReusePolicy |
Specifies what happens when Temporal workflows attempt to reuse workflow IDs.
This defaults to AllowDuplicate.
Workflows can customize this via WorkflowOptions or ChildWorkflowOptions
or by setting this in the WorkflowMethodAttribute tagging the
workflow entry point method
| ||||
![]() | WorkflowScheduleToStartTimeoutSeconds |
Specifies the default maximum time a workflow can wait between being scheduled
and actually begin executing. This defaults to 24 hours.
| ||||
![]() | WorkflowStartToCloseTimeoutSeconds |
Specifies the default maximum workflow execution time. This defaults to 24 hours.
|
Name | Description | |
---|---|---|
![]() | Clone |
Returns a copy of the current instance.
|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |