Class TemporalConnectionOptions
- Namespace
- Temporalio.Client
- Assembly
- Temporalio.dll
Options for ConnectAsync(TemporalConnectionOptions). TargetHost is required.
public class TemporalConnectionOptions : ICloneable
- Inheritance
-
TemporalConnectionOptions
- Implements
- Derived
- Inherited Members
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
stringTarget host to connect to.
- See Also
Properties
Identity
Gets or sets the identity for this connection.
public string? Identity { get; set; }
Property Value
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).
public IReadOnlyCollection<KeyValuePair<string, string>>? RpcMetadata { get; set; }
Property Value
Remarks
Note, this is only the initial value, updates will not be applied. Use RpcMetadata property setter to update.
- See Also
RpcRetry
Gets or sets retry options for this connection.
public RpcRetryOptions? RpcRetry { get; set; }
Property Value
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
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
Remarks
This is required for all connections.
Tls
Gets or sets the TLS options for connection.
public TlsOptions? Tls { get; set; }
Property Value
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.