Class ClientEnvConfig

Namespace

Temporalio.Client.EnvConfig

Assembly

Temporalio.dll

Represents the overall client configuration.

public sealed record ClientEnvConfig : IEquatable<ClientEnvConfig>

Inheritance

object

ClientEnvConfig

Implements

IEquatable<ClientEnvConfig>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ClientEnvConfig(IReadOnlyDictionary<string, Profile>)

Represents the overall client configuration.

public ClientEnvConfig(IReadOnlyDictionary<string, ClientEnvConfig.Profile> Profiles)

Parameters

Profiles IReadOnlyDictionary<string, ClientEnvConfig.Profile>

The configuration profiles.

Properties

Profiles

The configuration profiles.

public IReadOnlyDictionary<string, ClientEnvConfig.Profile> Profiles { get; init; }

Property Value

IReadOnlyDictionary<string, ClientEnvConfig.Profile>

Methods

FromDictionary(IReadOnlyDictionary<string, Dictionary<string, object>>)

Create a ClientEnvConfig from a dictionary structure.

public static ClientEnvConfig FromDictionary(IReadOnlyDictionary<string, Dictionary<string, object>> profileDictionaries)

Parameters

profileDictionaries IReadOnlyDictionary<string, Dictionary<string, object>>

Dictionary of profile name to profile dictionary.

Returns

ClientEnvConfig

Client configuration instance.

Load(ConfigLoadOptions?)

Load client configuration from environment variables and configuration files.

public static ClientEnvConfig Load(ClientEnvConfig.ConfigLoadOptions? options = null)

Parameters

options ClientEnvConfig.ConfigLoadOptions

Options for loading the configuration.

Returns

ClientEnvConfig

Loaded configuration data.

LoadClientConnectOptions(ProfileLoadOptions?)

Load client connection options directly from configuration.

public static TemporalClientConnectOptions LoadClientConnectOptions(ClientEnvConfig.ProfileLoadOptions? options = null)

Parameters

options ClientEnvConfig.ProfileLoadOptions

Options for loading the configuration profile.

Returns

TemporalClientConnectOptions

Client connection options.

ToDictionary()

Convert to a dictionary structure that can be used for TOML serialization.

public IReadOnlyDictionary<string, Dictionary<string, object>> ToDictionary()

Returns

IReadOnlyDictionary<string, Dictionary<string, object>>

Dictionary mapping profile names to their dictionary representations.