Class DevServerOptions

Namespace

Temporalio.Testing

Assembly

Temporalio.dll

Options for the dev server that backs a local workflow environment.

public class DevServerOptions : ICloneable

Inheritance

object

DevServerOptions

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

These options are specific to the Temporal CLI dev server implementation. If that implementation changes, these options and their values may no longer be valid.

Properties

DatabaseFilename

Gets or sets the database filename for the dev server.

public string? DatabaseFilename { get; set; }

Property Value

string

Remarks

By default, an in-memory database is used.

DownloadTtl

Gets or sets how long the automatic download should be cached for. If null, cached indefinitely.

public TimeSpan? DownloadTtl { get; set; }

Property Value

TimeSpan?

DownloadVersion

Gets or sets the version to version of the dev server to download. Default is "default".

public string DownloadVersion { get; set; }

Property Value

string

Remarks

By default, the best one for this SDK version is chosen. This can be a semantic version, "latest", or "default".

ExistingPath

Gets or sets the existing executable path for the dev server.

public string? ExistingPath { get; set; }

Property Value

string

ExtraArgs

Gets or sets the extra arguments for the dev server.

public IReadOnlyCollection<string>? ExtraArgs { get; set; }

Property Value

IReadOnlyCollection<string>

Remarks

Newlines are not allowed in values. If the dev server implementation changes, there is no guarantee these arguments will continue to be supported.

LogFormat

Gets or sets the log format for the dev server. Default is "pretty".

public string LogFormat { get; set; }

Property Value

string

LogLevel

Gets or sets the log level for the dev server. Default is "warn".

public string LogLevel { get; set; }

Property Value

string

StartupTimeout

Gets or sets how long to wait for the dev server to become ready after it is started. If null, five seconds.

public TimeSpan? StartupTimeout { get; set; }

Property Value

TimeSpan?

Remarks

This does not include time spent downloading the dev server.

Methods

Clone()

Create a shallow copy of these options.

public virtual object Clone()

Returns

object

A shallow copy of these options.

Remarks

Does not create a copy of the extra args.