Skip to main content

ConductorClient

Struct ConductorClient 

Source
pub struct ConductorClient { /* private fields */ }
Expand description

Main Conductor client combining all API clients.

This is the primary entry point for interacting with the Conductor API. Also available as the OrkesClients alias.

Implementations§

Source§

impl ConductorClient

Source

pub fn new(config: Configuration) -> Result<Self>

Create a new Conductor client with the given configuration.

§Errors

Returns crate::error::ConductorError::Http if the underlying reqwest client fails to build (e.g. TLS backend initialization failure) – this doesn’t make any network request.

Source

pub fn from_api_client(api: ApiClient) -> Self

Create from an existing API client.

Source

pub fn with_event_dispatcher(self, events: EventDispatcher) -> Self

Share an EventDispatcher with this client so that service clients (such as WorkflowClient) publish events to it.

Typically used to route workflow-lifecycle events through the same dispatcher as TaskHandler, allowing a single MetricsCollector to observe both task- and workflow-level metrics.

Source

pub fn event_dispatcher(&self) -> &EventDispatcher

Access the shared event dispatcher.

Source

pub fn task_client(&self) -> TaskClient

Get the task client for polling and updating tasks.

Source

pub fn get_task_client(&self) -> TaskClient

Alias for task_client().

Source

pub fn workflow_client(&self) -> WorkflowClient

Get the workflow client for workflow operations.

Source

pub fn get_workflow_client(&self) -> WorkflowClient

Alias for workflow_client().

Source

pub fn metadata_client(&self) -> MetadataClient

Get the metadata client for managing definitions.

Source

pub fn get_metadata_client(&self) -> MetadataClient

Alias for metadata_client().

Source

pub fn orkes_metadata_client(&self) -> OrkesMetadataClient

Get the Orkes metadata client with tagging APIs.

This client extends MetadataClient with Orkes-specific features like workflow and task tagging. Access base methods via Deref.

Source

pub fn get_orkes_metadata_client(&self) -> OrkesMetadataClient

Alias for orkes_metadata_client().

Source

pub fn scheduler_client(&self) -> SchedulerClient

Get the scheduler client for managing workflow schedules.

Source

pub fn get_scheduler_client(&self) -> SchedulerClient

Alias for scheduler_client().

Source

pub fn secret_client(&self) -> SecretClient

Get the secret client for managing secrets.

Source

pub fn get_secret_client(&self) -> SecretClient

Alias for secret_client().

Source

pub fn authorization_client(&self) -> AuthorizationClient

Get the authorization client for users, groups, and permissions.

Source

pub fn get_authorization_client(&self) -> AuthorizationClient

Alias for authorization_client().

Source

pub fn integration_client(&self) -> IntegrationClient

Get the integration client for external system integrations.

Source

pub fn get_integration_client(&self) -> IntegrationClient

Alias for integration_client().

Source

pub fn prompt_client(&self) -> PromptClient

Get the prompt client for AI prompt templates.

Source

pub fn get_prompt_client(&self) -> PromptClient

Alias for prompt_client().

Source

pub fn schema_client(&self) -> SchemaClient

Get the schema client for schema definitions.

Source

pub fn get_schema_client(&self) -> SchemaClient

Alias for schema_client().

Source

pub fn event_client(&self) -> EventClient

Get the event client for event queue configurations.

Source

pub fn get_event_client(&self) -> EventClient

Alias for event_client().

Source

pub fn api_client(&self) -> &ApiClient

Get the underlying API client.

Source

pub async fn is_oss(&self) -> bool

Check whether the server is OSS Conductor (vs Orkes Enterprise).

The result is cached after the first call. See ApiClient::is_oss for details on the detection mechanism.

Source

pub async fn config(&self) -> Configuration

Get configuration.

Trait Implementations§

Source§

impl Clone for ConductorClient

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

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