Class TestServerOptions

Namespace

Temporalio.Testing

Assembly

Temporalio.dll

Options for the test server that backs a time-skipping workflow environment.

public class TestServerOptions : ICloneable

Inheritance

object

TestServerOptions

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 time-skipping test server implementation. If that implementation changes, these options and their values may no longer be valid.

Properties

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 test 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 test server.

public string? ExistingPath { get; set; }

Property Value

string

ExtraArgs

Gets or sets the extra arguments for the test server.

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

Property Value

IReadOnlyCollection<string>

Remarks

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

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.