Class TemporalConnectionOptions

Options for . TargetHost is required.

Inheritance

Object

TemporalConnectionOptions

TemporalClientConnectOptions

Namespace: Temporalio.Client

Assembly: Temporalio.dll

Syntax

public class TemporalConnectionOptions : ICloneable

Constructors

TemporalConnectionOptions()

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

Declaration

public TemporalConnectionOptions()

TemporalConnectionOptions(String)

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

Declaration

public TemporalConnectionOptions(string targetHost)

Parameters

Type	Name	Description
String	targetHost	Target host to connect to.

See Also

TargetHost

Properties

Identity

Gets or sets the identity for this connection.

Declaration

public string? Identity { get; set; }

Property Value

Type	Description
Nullable<String>

Remarks

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

RpcMetadata

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

Declaration

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

Property Value

Type	Description
Nullable<IEnumerable<KeyValuePair<String, String>>>

See Also

Metadata

RpcRetry

Gets or sets retry options for this connection.

Declaration

public RpcRetryOptions RpcRetry { get; set; }

Property Value

Type	Description
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.

Declaration

public TemporalRuntime Runtime { get; set; }

Property Value

Type	Description
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.

Declaration

public string? TargetHost { get; set; }

Property Value

Type	Description
Nullable<String>

Remarks

This is required for all connections.

Tls

Gets or sets the TLS options for connection.

Declaration

public TlsOptions Tls { get; set; }

Property Value

Type	Description
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.

Declaration

public virtual object Clone()

Returns

Type	Description
Object	A shallow copy of these options and any transitive options fields.

Remarks

Does not create copies of RPC metadata or runtime.