Skip to main content

Configuration

Struct Configuration 

Source
pub struct Configuration {
    pub server_api_url: String,
    pub ui_host: String,
    pub auth_key: Option<String>,
    pub auth_secret: Option<String>,
    pub auth_token: Option<String>,
    pub token_update_time: Option<Instant>,
    pub auth_token_ttl: Duration,
    pub auth_disabled: bool,
    pub timeout: Duration,
    pub connect_timeout: Duration,
    pub debug: bool,
}
Expand description

Main configuration for Conductor client.

Fields§

§server_api_url: String

Conductor server API URL (e.g., “http://localhost:8080/api”).

§ui_host: String

UI host URL for viewing executions.

§auth_key: Option<String>

Authentication key (optional).

§auth_secret: Option<String>

Authentication secret (optional).

§auth_token: Option<String>

Current authentication token (managed internally).

§token_update_time: Option<Instant>

Time when the token was last updated.

§auth_token_ttl: Duration

Token time-to-live duration (default: 45 minutes).

§auth_disabled: bool

Whether authentication is disabled (e.g., OSS Conductor without auth).

§timeout: Duration

Request timeout.

§connect_timeout: Duration

Connection timeout.

§debug: bool

Enable debug logging.

Implementations§

Source§

impl Configuration

Source

pub fn from_env() -> Self

Create configuration from environment variables.

Environment variables:

  • CONDUCTOR_SERVER_URL: Conductor server API URL (default: http://localhost:8080/api)
  • CONDUCTOR_AUTH_KEY: Authentication key ID for Orkes Conductor
  • CONDUCTOR_AUTH_SECRET: Authentication secret for Orkes Conductor
  • CONDUCTOR_DEBUG: Enable debug mode (true/false)
  • CONDUCTOR_TIMEOUT_SECS: Request timeout in seconds (default: 30)
  • CONDUCTOR_AUTH_TOKEN_TTL_MINS: Token TTL in minutes (default: 45)

The SDK automatically handles token refresh when using Orkes Conductor. For open-source Conductor without authentication, simply omit the auth variables.

Source

pub fn new(server_api_url: impl Into<String>) -> Self

Create a new configuration with custom settings.

Source

pub fn with_auth( self, key: impl Into<String>, secret: impl Into<String>, ) -> Self

Set authentication credentials.

Source

pub fn with_token_ttl(self, ttl: Duration) -> Self

Set token TTL (time-to-live) duration.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Set timeout.

Source

pub fn with_debug(self, debug: bool) -> Self

Enable debug mode.

Source

pub fn update_token(&mut self, token: String)

Update the authentication token.

Source

pub fn clear_token(&mut self)

Clear the authentication token (e.g., after auth failure).

Source

pub fn disable_auth(&mut self)

Disable authentication (e.g., when server doesn’t require it).

Source

pub fn has_auth(&self) -> bool

Check if authentication is configured and not disabled.

Source

pub fn token_needs_refresh(&self) -> bool

Check if the token needs to be refreshed based on TTL.

Source

pub fn execution_url(&self, workflow_id: &str) -> String

Get the execution URL for a workflow.

Trait Implementations§

Source§

impl Clone for Configuration

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Configuration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Configuration

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more