Struct ClientOptionsBuilder 

pub struct ClientOptionsBuilder { /* private fields */ }

Builder for ClientOptions.

Implementations

impl ClientOptionsBuilder

pub fn target_url<VALUE>(&mut self, value: VALUE) -> &mut ClientOptionsBuilder

where VALUE: Into<Url>,

The URL of the Temporal server to connect to

pub fn client_name<VALUE>(&mut self, value: VALUE) -> &mut ClientOptionsBuilder

where VALUE: Into<String>,

The name of the SDK being implemented on top of core. Is set as client-name header in all RPC calls

pub fn client_version<VALUE>( &mut self, value: VALUE, ) -> &mut ClientOptionsBuilder

where VALUE: Into<String>,

The version of the SDK being implemented on top of core. Is set as client-version header in all RPC calls. The server decides if the client is supported based on this.

pub fn identity<VALUE>(&mut self, value: VALUE) -> &mut ClientOptionsBuilder

where VALUE: Into<String>,

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

pub fn tls_cfg(&mut self, value: TlsConfig) -> &mut ClientOptionsBuilder

If specified, use TLS as configured by the TlsConfig 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.

pub fn retry_config(&mut self, value: RetryConfig) -> &mut ClientOptionsBuilder

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

pub fn override_origin( &mut self, value: Option<Uri>, ) -> &mut ClientOptionsBuilder

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 TlsConfig::domain is set, and this is not, this will be set to https://<domain>, effectively making the :authority header consistent with the domain override.

pub fn keep_alive( &mut self, value: Option<ClientKeepAliveConfig>, ) -> &mut ClientOptionsBuilder

If set (which it is by default), HTTP2 gRPC keep alive will be enabled.

pub fn headers( &mut self, value: Option<HashMap<String, String>>, ) -> &mut ClientOptionsBuilder

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 ClientOptions::binary_headers. Invalid header keys or values will cause an error to be returned when connecting.

pub fn binary_headers( &mut self, value: Option<HashMap<String, Vec<u8>>>, ) -> &mut ClientOptionsBuilder

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.

pub fn api_key(&mut self, value: Option<String>) -> &mut ClientOptionsBuilder

API key which is set as the “Authorization” header with “Bearer “ prepended. This will only be applied if the headers don’t already have an “Authorization” header.

pub fn http_connect_proxy( &mut self, value: Option<HttpConnectProxyOptions>, ) -> &mut ClientOptionsBuilder

HTTP CONNECT proxy to use for this client.

pub fn disable_error_code_metric_tags( &mut self, value: bool, ) -> &mut ClientOptionsBuilder

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

pub fn skip_get_system_info(&mut self, value: bool) -> &mut ClientOptionsBuilder

If set true, get_system_info will not be called upon connection

pub fn build(&self) -> Result<ClientOptions, ClientOptionsBuilderError>

Builds a new ClientOptions.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ClientOptionsBuilder

fn clone(&self) -> ClientOptionsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClientOptionsBuilder

fn default() -> ClientOptionsBuilder

Returns the “default value” for a type.