Module: Temporalio::EnvConfig

Defined in:

lib/temporalio/env_config.rb

Overview

Environment and file-based configuration for Temporal clients

WARNING: Experimental API.

Defined Under Namespace

Classes: ClientConfig, ClientConfigProfile, ClientConfigTLS

Instance Attribute Summary

• #address ⇒ String^? readonly

  Client address.

• #api_key ⇒ String^? readonly

  Client API key.

• #client_cert ⇒ Pathname, ... readonly

  Client certificate source.

• #client_private_key ⇒ Pathname, ... readonly

  Client key source.

• #disabled ⇒ Boolean^? readonly

  If true, TLS is explicitly disabled; if nil, not specified.

• #grpc_meta ⇒ Hash readonly

  GRPC metadata.

• #namespace ⇒ String^? readonly

  Client namespace.

• #profiles ⇒ Hash<String, ClientConfigProfile> readonly

  Map of profile name to its corresponding ClientConfigProfile.

• #server_name ⇒ String^? readonly

  SNI override.

• #server_root_ca_cert ⇒ Pathname, ... readonly

  Server CA certificate source.

• #tls ⇒ ClientConfigTLS^? readonly

  TLS configuration.

Instance Attribute Details

#address ⇒ String^? (readonly)

Returns Client address.

Returns:

• (String, nil) —

  Client address

# File 'lib/temporalio/env_config.rb', line 141

ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)

#api_key ⇒ String^? (readonly)

Returns Client API key.

Returns:

• (String, nil) —

  Client API key

# File 'lib/temporalio/env_config.rb', line 141

ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)

#client_cert ⇒ Pathname, ... (readonly)

Returns Client certificate source.

Returns:

• (Pathname, String, nil) —

  Client certificate source

# File 'lib/temporalio/env_config.rb', line 26

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#client_private_key ⇒ Pathname, ... (readonly)

Returns Client key source.

Returns:

• (Pathname, String, nil) —

  Client key source

# File 'lib/temporalio/env_config.rb', line 26

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#disabled ⇒ Boolean^? (readonly)

Returns If true, TLS is explicitly disabled; if nil, not specified.

Returns:

• (Boolean, nil) —

  If true, TLS is explicitly disabled; if nil, not specified

# File 'lib/temporalio/env_config.rb', line 26

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#grpc_meta ⇒ Hash (readonly)

Returns gRPC metadata.

Returns:

• (Hash) —

  gRPC metadata

# File 'lib/temporalio/env_config.rb', line 141

ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)

#namespace ⇒ String^? (readonly)

Returns Client namespace.

Returns:

• (String, nil) —

  Client namespace

# File 'lib/temporalio/env_config.rb', line 141

ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)

#profiles ⇒ Hash<String, ClientConfigProfile> (readonly)

Returns Map of profile name to its corresponding ClientConfigProfile.

Returns:

• (Hash<String, ClientConfigProfile>) —

  Map of profile name to its corresponding ClientConfigProfile

# File 'lib/temporalio/env_config.rb', line 232

ClientConfig = Data.define(:profiles)

#server_name ⇒ String^? (readonly)

Returns SNI override.

Returns:

• (String, nil) —

  SNI override

# File 'lib/temporalio/env_config.rb', line 26

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#server_root_ca_cert ⇒ Pathname, ... (readonly)

Returns Server CA certificate source.

Returns:

• (Pathname, String, nil) —

  Server CA certificate source

# File 'lib/temporalio/env_config.rb', line 26

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#tls ⇒ ClientConfigTLS^? (readonly)

Returns TLS configuration.

Returns:

• (ClientConfigTLS, nil) —

  TLS configuration

# File 'lib/temporalio/env_config.rb', line 141

ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)