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
impl ConductorClient
Sourcepub fn new(config: Configuration) -> Result<Self>
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.
Sourcepub fn from_api_client(api: ApiClient) -> Self
pub fn from_api_client(api: ApiClient) -> Self
Create from an existing API client.
Sourcepub fn with_event_dispatcher(self, events: EventDispatcher) -> Self
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.
Sourcepub fn event_dispatcher(&self) -> &EventDispatcher
pub fn event_dispatcher(&self) -> &EventDispatcher
Access the shared event dispatcher.
Sourcepub fn task_client(&self) -> TaskClient
pub fn task_client(&self) -> TaskClient
Get the task client for polling and updating tasks.
Sourcepub fn get_task_client(&self) -> TaskClient
pub fn get_task_client(&self) -> TaskClient
Alias for task_client().
Sourcepub fn workflow_client(&self) -> WorkflowClient
pub fn workflow_client(&self) -> WorkflowClient
Get the workflow client for workflow operations.
Sourcepub fn get_workflow_client(&self) -> WorkflowClient
pub fn get_workflow_client(&self) -> WorkflowClient
Alias for workflow_client().
Sourcepub fn metadata_client(&self) -> MetadataClient
pub fn metadata_client(&self) -> MetadataClient
Get the metadata client for managing definitions.
Sourcepub fn get_metadata_client(&self) -> MetadataClient
pub fn get_metadata_client(&self) -> MetadataClient
Alias for metadata_client().
Sourcepub fn orkes_metadata_client(&self) -> OrkesMetadataClient
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.
Sourcepub fn get_orkes_metadata_client(&self) -> OrkesMetadataClient
pub fn get_orkes_metadata_client(&self) -> OrkesMetadataClient
Alias for orkes_metadata_client().
Sourcepub fn scheduler_client(&self) -> SchedulerClient
pub fn scheduler_client(&self) -> SchedulerClient
Get the scheduler client for managing workflow schedules.
Sourcepub fn get_scheduler_client(&self) -> SchedulerClient
pub fn get_scheduler_client(&self) -> SchedulerClient
Alias for scheduler_client().
Sourcepub fn secret_client(&self) -> SecretClient
pub fn secret_client(&self) -> SecretClient
Get the secret client for managing secrets.
Sourcepub fn get_secret_client(&self) -> SecretClient
pub fn get_secret_client(&self) -> SecretClient
Alias for secret_client().
Get the authorization client for users, groups, and permissions.
Alias for authorization_client().
Sourcepub fn integration_client(&self) -> IntegrationClient
pub fn integration_client(&self) -> IntegrationClient
Get the integration client for external system integrations.
Sourcepub fn get_integration_client(&self) -> IntegrationClient
pub fn get_integration_client(&self) -> IntegrationClient
Alias for integration_client().
Sourcepub fn prompt_client(&self) -> PromptClient
pub fn prompt_client(&self) -> PromptClient
Get the prompt client for AI prompt templates.
Sourcepub fn get_prompt_client(&self) -> PromptClient
pub fn get_prompt_client(&self) -> PromptClient
Alias for prompt_client().
Sourcepub fn schema_client(&self) -> SchemaClient
pub fn schema_client(&self) -> SchemaClient
Get the schema client for schema definitions.
Sourcepub fn get_schema_client(&self) -> SchemaClient
pub fn get_schema_client(&self) -> SchemaClient
Alias for schema_client().
Sourcepub fn event_client(&self) -> EventClient
pub fn event_client(&self) -> EventClient
Get the event client for event queue configurations.
Sourcepub fn get_event_client(&self) -> EventClient
pub fn get_event_client(&self) -> EventClient
Alias for event_client().
Sourcepub fn api_client(&self) -> &ApiClient
pub fn api_client(&self) -> &ApiClient
Get the underlying API client.
Sourcepub async fn is_oss(&self) -> bool
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.
Sourcepub async fn config(&self) -> Configuration
pub async fn config(&self) -> Configuration
Get configuration.