Class TemporalConnectionOptions

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Options for ConnectAsync(TemporalConnectionOptions). TargetHost is required.

public class TemporalConnectionOptions : ICloneable

Inheritance

object

TemporalConnectionOptions

Implements

ICloneable

Derived

TemporalClientConnectOptions

TemporalCloudOperationsClientConnectOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TemporalConnectionOptions()

Initializes a new instance of the TemporalConnectionOptions class. Create default options.

public TemporalConnectionOptions()

TemporalConnectionOptions(string)

Initializes a new instance of the TemporalConnectionOptions class. Create default options with a target host.

public TemporalConnectionOptions(string targetHost)

Parameters

targetHost string

Target host to connect to.

See Also

TargetHost

Properties

ApiKey

Gets or sets the API key for all calls.

public string? ApiKey { get; set; }

Property Value

string

Remarks

This is the "Authorization" HTTP header for every call, with "Bearer " prepended. This is only set if the RPC metadata doesn't already have an "Authorization" key. Note, this is only the initial value, updates will not be applied. Use ApiKey property setter to update.

HttpConnectProxy

Gets or sets HTTP connect proxy options for this connection.

public HttpConnectProxyOptions? HttpConnectProxy { get; set; }

Property Value

HttpConnectProxyOptions

Identity

Gets or sets the identity for this connection.

public string? Identity { get; set; }

Property Value

string

Remarks

By default this is pid@hostname. This default may be set when the options object is first used.

KeepAlive

Gets or sets keep alive options for this connection.

public KeepAliveOptions? KeepAlive { get; set; }

Property Value

KeepAliveOptions

Remarks

Default enabled, set to null to disable.

RpcMetadata

Gets or sets the gRPC metadata for all calls (i.e. the headers).

public IReadOnlyCollection<KeyValuePair<string, string>>? RpcMetadata { get; set; }

Property Value

IReadOnlyCollection<KeyValuePair<string, string>>

Remarks

Note, this is only the initial value, updates will not be applied. Use RpcMetadata property setter to update.

See Also

Metadata

RpcRetry

Gets or sets retry options for this connection.

public RpcRetryOptions? RpcRetry { get; set; }

Property Value

RpcRetryOptions

Remarks

This only applies if the call is being retried, which by default is usually all high-level client calls but no raw gRPC calls.

Runtime

Gets or sets runtime for this connection.

public TemporalRuntime? Runtime { get; set; }

Property Value

TemporalRuntime

Remarks

By default this uses Default which is lazily created when first needed.

TargetHost

Gets or sets the Temporal server host:port to connect to.

public string? TargetHost { get; set; }

Property Value

string

Remarks

This is required for all connections.

Tls

Gets or sets the TLS options for connection.

public TlsOptions? Tls { get; set; }

Property Value

TlsOptions

Remarks

This must be set, even to a default instance, to do any TLS connection.

Methods

Clone()

Create a shallow copy of these options.

public virtual object Clone()

Returns

object

A shallow copy of these options and any transitive options fields.

Remarks

Does not create copies of RPC metadata or runtime.