Class ClientEnvConfig.Profile

Namespace

Temporalio.Client.EnvConfig

Assembly

Temporalio.dll

Represents a client configuration profile.

public sealed record ClientEnvConfig.Profile : IEquatable<ClientEnvConfig.Profile>

Inheritance

object

ClientEnvConfig.Profile

Implements

IEquatable<ClientEnvConfig.Profile>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Profile(string?, string?, string?, Tls?, IReadOnlyDictionary<string, string>?)

Represents a client configuration profile.

public Profile(string? Address = null, string? Namespace = null, string? ApiKey = null, ClientEnvConfig.Tls? Tls = null, IReadOnlyDictionary<string, string>? GrpcMeta = null)

Parameters

Address string

Client address.

Namespace string

Client namespace.

ApiKey string

Client API key.

Tls ClientEnvConfig.Tls

TLS configuration.

GrpcMeta IReadOnlyDictionary<string, string>

gRPC metadata.

Properties

Address

Client address.

public string? Address { get; init; }

Property Value

string

ApiKey

Client API key.

public string? ApiKey { get; init; }

Property Value

string

GrpcMeta

gRPC metadata.

public IReadOnlyDictionary<string, string>? GrpcMeta { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Namespace

Client namespace.

public string? Namespace { get; init; }

Property Value

string

Tls

TLS configuration.

public ClientEnvConfig.Tls? Tls { get; init; }

Property Value

ClientEnvConfig.Tls

Methods

FromDictionary(IReadOnlyDictionary<string, object>)

Create a Profile from a dictionary structure.

public static ClientEnvConfig.Profile FromDictionary(IReadOnlyDictionary<string, object> dictionary)

Parameters

dictionary IReadOnlyDictionary<string, object>

The dictionary to convert from.

Returns

ClientEnvConfig.Profile

Profile configuration instance.

Load(ProfileLoadOptions?)

Loads a specific profile with environment variable overrides.

public static ClientEnvConfig.Profile Load(ClientEnvConfig.ProfileLoadOptions? options = null)

Parameters

options ClientEnvConfig.ProfileLoadOptions

Options for loading the configuration profile.

Returns

ClientEnvConfig.Profile

The loaded profile.

ToClientConnectionOptions()

Create a TemporalClientConnectOptions from this profile.

public TemporalClientConnectOptions ToClientConnectionOptions()

Returns

TemporalClientConnectOptions

Connection options for a client.

ToDictionary()

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

public Dictionary<string, object> ToDictionary()

Returns

Dictionary<string, object>

Dictionary representation of this profile.