Struct ConnectionOptions 

#[non_exhaustive]
pub struct ConnectionOptions {

    pub target: Url,
    pub identity: String,
    pub metrics_meter: Option<TemporalMeter>,
    pub tls_options: Option<TlsOptions>,
    pub override_origin: Option<Uri>,
    pub api_key: Option<String>,
    pub connect_timeout: Option<Duration>,
    pub retry_options: RetryOptions,
    pub keep_alive: Option<ClientKeepAliveOptions>,
    pub headers: Option<HashMap<String, String>>,
    pub binary_headers: Option<HashMap<String, Vec<u8>>>,
    pub http_connect_proxy: Option<HttpConnectProxyOptions>,
    pub dns_load_balancing: Option<DnsLoadBalancingOptions>,
    pub disable_error_code_metric_tags: bool,
    pub service_override: Option<CallbackBasedGrpcService>,
    pub grpc_compression: GrpcCompression,
    pub payload_limits: PayloadLimitsOptions,
    /* private fields */
}

Options for crate::Connection::connect.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target: Url

The server to connect to.

identity: String

A human-readable string that can identify this process. Defaults to empty string.

metrics_meter: Option<TemporalMeter>

When set, this client will record metrics using the provided meter. The meter can be obtained from temporalio_common::telemetry::TelemetryInstance::get_temporal_metric_meter.

tls_options: Option<TlsOptions>

If specified, use TLS as configured by the TlsOptions struct. If this is set core will attempt to use TLS when connecting to the Temporal server. Lang SDK is expected to pass any certs or keys as bytes, loading them from disk itself if needed.

override_origin: Option<Uri>

If set, override the origin used when connecting. May be useful in rare situations where tls verification needs to use a different name from what should be set as the :authority header. If TlsOptions::domain is set, and this is not, this will be set to https://<domain>, effectively making the :authority header consistent with the domain override.

api_key: Option<String>

An API key to use for auth. If set, TLS will be enabled by default, but without any mTLS specific settings.

connect_timeout: Option<Duration>

When set, limits the time allowed to establish the initial TCP/TLS connection to the server. If the connection cannot be established within this duration, connect will return an error. When None (the default), no explicit timeout is applied and the connection attempt may block indefinitely (subject to OS-level TCP timeouts).

retry_options: RetryOptions

Retry configuration for the server client. Default is RetryOptions::default

keep_alive: Option<ClientKeepAliveOptions>

If set, HTTP2 gRPC keep alive will be enabled. To enable with default settings, use .keep_alive(Some(ClientKeepAliveConfig::default())).

headers: Option<HashMap<String, String>>

HTTP headers to include on every RPC call.

These must be valid gRPC metadata keys, and must not be binary metadata keys (ending in `-bin). To set binary headers, use ConnectionOptions::binary_headers. Invalid header keys or values will cause an error to be returned when connecting.

binary_headers: Option<HashMap<String, Vec<u8>>>

HTTP headers to include on every RPC call as binary gRPC metadata (encoded as base64).

These must be valid binary gRPC metadata keys (and end with a -bin suffix). Invalid header keys will cause an error to be returned when connecting.

http_connect_proxy: Option<HttpConnectProxyOptions>

HTTP CONNECT proxy to use for this client.

dns_load_balancing: Option<DnsLoadBalancingOptions>

If set, DNS-based load balancing is enabled. When the target is a hostname (not an IP literal), DNS is resolved to all addresses and requests are distributed across them. Incompatible with service_override and http_connect_proxy. Setting either in addition to this field is an error. Set to None to disable.

disable_error_code_metric_tags: bool

If set true, error code labels will not be included on request failure metrics.

service_override: Option<CallbackBasedGrpcService>

If set, all gRPC calls will be routed through the provided service.

grpc_compression: GrpcCompression

Controls transport-level gRPC compression for the client. Defaults to GrpcCompression::Gzip, which compresses outbound request bodies and accepts compressed responses. Set to GrpcCompression::None to opt out. If service_override is specified, is forced to None.

payload_limits: PayloadLimitsOptions

Payload size limit options for this connection. Defaults to the standard warning thresholds; disable an individual warning by setting its threshold to 0. NOTE: Experimental

Implementations

impl ConnectionOptions

pub fn new(target: impl Into<Url>) -> ConnectionOptionsBuilder

Create an instance of ConnectionOptions using the builder syntax

Trait Implementations

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<ClientConfigProfile> for ConnectionOptions

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(profile: ClientConfigProfile) -> Result<Self, Self::Error>

Performs the conversion.