Class ClientEnvConfig
- Namespace
- Temporalio.Common.EnvConfig
- Assembly
- Temporalio.dll
Represents the overall client configuration.
public sealed record ClientEnvConfig : IEquatable<ClientEnvConfig>
- Inheritance
-
ClientEnvConfig
- Implements
- Inherited Members
Constructors
ClientEnvConfig(IReadOnlyDictionary<string, Profile>)
Represents the overall client configuration.
public ClientEnvConfig(IReadOnlyDictionary<string, ClientEnvConfig.Profile> Profiles)
Parameters
ProfilesIReadOnlyDictionary<string, ClientEnvConfig.Profile>The configuration profiles.
Properties
Profiles
The configuration profiles.
public IReadOnlyDictionary<string, ClientEnvConfig.Profile> Profiles { get; init; }
Property Value
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
profileDictionariesIReadOnlyDictionary<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
optionsClientEnvConfig.ConfigLoadOptionsOptions for loading the configuration.
Returns
- ClientEnvConfig
Loaded configuration data.
LoadClientConnectOptions(ProfileLoadOptions?)
Load client connection options directly from configuration, then apply any Extensions. Extensions are called in order, and the plugins they return are set as Plugins.
public static TemporalClientConnectOptions LoadClientConnectOptions(ClientEnvConfig.ProfileLoadOptions? options = null)
Parameters
optionsClientEnvConfig.ProfileLoadOptionsOptions for loading the configuration profile.
Returns
- TemporalClientConnectOptions
Client connection options.
Exceptions
- ArgumentException
Thrown for an invalid extension list.
- InvalidOperationException
Thrown when loading fails, including when an extension throws (as the inner exception).
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.