pub struct WorkflowClient { /* private fields */ }Expand description
Client for workflow operations.
Implementations§
Source§impl WorkflowClient
impl WorkflowClient
Sourcepub fn new(api: ApiClient) -> Self
pub fn new(api: ApiClient) -> Self
Create a new workflow client without an event dispatcher.
The WorkflowStarted / WorkflowStartFailure events will still be
published, but no listeners will see them. Use
WorkflowClient::new_with_events to wire a shared dispatcher (e.g.
one owned by TaskHandler) so the
MetricsCollector can observe workflow-start metrics.
Sourcepub fn new_with_events(api: ApiClient, events: EventDispatcher) -> Self
pub fn new_with_events(api: ApiClient, events: EventDispatcher) -> Self
Create a new workflow client wired to an existing EventDispatcher.
Sourcepub async fn start_workflow(
&self,
request: &StartWorkflowRequest,
) -> Result<String>
pub async fn start_workflow( &self, request: &StartWorkflowRequest, ) -> Result<String>
Start a workflow asynchronously.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn execute_workflow(
&self,
request: &StartWorkflowRequest,
wait_for: Duration,
) -> Result<Workflow>
pub async fn execute_workflow( &self, request: &StartWorkflowRequest, wait_for: Duration, ) -> Result<Workflow>
Execute a workflow synchronously and wait for completion.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn get_workflow(
&self,
workflow_id: &str,
include_tasks: bool,
) -> Result<Workflow>
pub async fn get_workflow( &self, workflow_id: &str, include_tasks: bool, ) -> Result<Workflow>
Get workflow by ID.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn get_workflow_status(
&self,
workflow_id: &str,
include_output: bool,
include_variables: bool,
) -> Result<Workflow>
pub async fn get_workflow_status( &self, workflow_id: &str, include_output: bool, include_variables: bool, ) -> Result<Workflow>
Get workflow status.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn terminate_workflow(
&self,
workflow_id: &str,
reason: Option<&str>,
trigger_failure_workflow: bool,
) -> Result<()>
pub async fn terminate_workflow( &self, workflow_id: &str, reason: Option<&str>, trigger_failure_workflow: bool, ) -> Result<()>
Terminate a running workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.
Sourcepub async fn pause_workflow(&self, workflow_id: &str) -> Result<()>
pub async fn pause_workflow(&self, workflow_id: &str) -> Result<()>
Pause a running workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn resume_workflow(&self, workflow_id: &str) -> Result<()>
pub async fn resume_workflow(&self, workflow_id: &str) -> Result<()>
Resume a paused workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn retry_workflow(
&self,
workflow_id: &str,
resume_subworkflow_tasks: bool,
) -> Result<()>
pub async fn retry_workflow( &self, workflow_id: &str, resume_subworkflow_tasks: bool, ) -> Result<()>
Retry a failed workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn restart_workflow(
&self,
workflow_id: &str,
use_latest_def: bool,
) -> Result<()>
pub async fn restart_workflow( &self, workflow_id: &str, use_latest_def: bool, ) -> Result<()>
Restart a workflow from the beginning.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn rerun_workflow(
&self,
workflow_id: &str,
rerun_from_task_id: &str,
task_input: Option<HashMap<String, Value>>,
workflow_input: Option<HashMap<String, Value>>,
) -> Result<String>
pub async fn rerun_workflow( &self, workflow_id: &str, rerun_from_task_id: &str, task_input: Option<HashMap<String, Value>>, workflow_input: Option<HashMap<String, Value>>, ) -> Result<String>
Rerun a workflow from a specific task.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn update_variables(
&self,
workflow_id: &str,
variables: HashMap<String, Value>,
) -> Result<Workflow>
pub async fn update_variables( &self, workflow_id: &str, variables: HashMap<String, Value>, ) -> Result<Workflow>
Update workflow variables.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn skip_task(
&self,
workflow_id: &str,
task_reference_name: &str,
) -> Result<()>
pub async fn skip_task( &self, workflow_id: &str, task_reference_name: &str, ) -> Result<()>
Skip a task in a running workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn search_workflows(
&self,
query: Option<&str>,
free_text: Option<&str>,
start: i32,
size: i32,
) -> Result<SearchResult<Workflow>>
pub async fn search_workflows( &self, query: Option<&str>, free_text: Option<&str>, start: i32, size: i32, ) -> Result<SearchResult<Workflow>>
Search for workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn search_workflows_v2(
&self,
query: Option<&str>,
free_text: Option<&str>,
start: i32,
size: i32,
) -> Result<SearchResult<Workflow>>
pub async fn search_workflows_v2( &self, query: Option<&str>, free_text: Option<&str>, start: i32, size: i32, ) -> Result<SearchResult<Workflow>>
Search for workflows V2 (returns full workflow objects).
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn skip_task_from_workflow(
&self,
workflow_id: &str,
task_reference_name: &str,
) -> Result<()>
pub async fn skip_task_from_workflow( &self, workflow_id: &str, task_reference_name: &str, ) -> Result<()>
Skip a task from workflow (alias for skip_task).
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn pause_workflows(
&self,
workflow_ids: &[String],
) -> Result<HashMap<String, Value>>
pub async fn pause_workflows( &self, workflow_ids: &[String], ) -> Result<HashMap<String, Value>>
Bulk pause workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn resume_workflows(
&self,
workflow_ids: &[String],
) -> Result<HashMap<String, Value>>
pub async fn resume_workflows( &self, workflow_ids: &[String], ) -> Result<HashMap<String, Value>>
Bulk resume workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn restart_workflows(
&self,
workflow_ids: &[String],
use_latest_def: bool,
) -> Result<HashMap<String, Value>>
pub async fn restart_workflows( &self, workflow_ids: &[String], use_latest_def: bool, ) -> Result<HashMap<String, Value>>
Bulk restart workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn retry_workflows(
&self,
workflow_ids: &[String],
) -> Result<HashMap<String, Value>>
pub async fn retry_workflows( &self, workflow_ids: &[String], ) -> Result<HashMap<String, Value>>
Bulk retry workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn terminate_workflows(
&self,
workflow_ids: &[String],
reason: Option<&str>,
) -> Result<HashMap<String, Value>>
pub async fn terminate_workflows( &self, workflow_ids: &[String], reason: Option<&str>, ) -> Result<HashMap<String, Value>>
Bulk terminate workflows.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn get_running_workflows(
&self,
workflow_name: &str,
version: Option<i32>,
start_time: Option<i64>,
end_time: Option<i64>,
) -> Result<Vec<String>>
pub async fn get_running_workflows( &self, workflow_name: &str, version: Option<i32>, start_time: Option<i64>, end_time: Option<i64>, ) -> Result<Vec<String>>
Get running workflows by name.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn delete_workflow(
&self,
workflow_id: &str,
archive: bool,
) -> Result<()>
pub async fn delete_workflow( &self, workflow_id: &str, archive: bool, ) -> Result<()>
Delete a workflow execution.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.
Sourcepub async fn test_workflow(
&self,
request: &TestWorkflowRequest,
) -> Result<Workflow>
pub async fn test_workflow( &self, request: &TestWorkflowRequest, ) -> Result<Workflow>
Test a workflow (dry run).
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn remove_workflow(&self, workflow_id: &str) -> Result<()>
pub async fn remove_workflow(&self, workflow_id: &str) -> Result<()>
Remove/delete a workflow.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn get_by_correlation_ids(
&self,
workflow_name: &str,
correlation_ids: &[String],
include_completed: bool,
include_tasks: bool,
) -> Result<HashMap<String, Vec<Workflow>>>
pub async fn get_by_correlation_ids( &self, workflow_name: &str, correlation_ids: &[String], include_completed: bool, include_tasks: bool, ) -> Result<HashMap<String, Vec<Workflow>>>
Get workflows by correlation IDs.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn get_by_correlation_ids_in_batch(
&self,
batch_request: &CorrelationIdsSearchRequest,
include_completed: bool,
include_tasks: bool,
) -> Result<HashMap<String, Vec<Workflow>>>
pub async fn get_by_correlation_ids_in_batch( &self, batch_request: &CorrelationIdsSearchRequest, include_completed: bool, include_tasks: bool, ) -> Result<HashMap<String, Vec<Workflow>>>
Get workflows by correlation IDs in batch.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn update_state(
&self,
workflow_id: &str,
update_request: &WorkflowStateUpdate,
wait_until_task_ref_names: Option<&[String]>,
wait_for_seconds: Option<i32>,
) -> Result<WorkflowRun>
pub async fn update_state( &self, workflow_id: &str, update_request: &WorkflowStateUpdate, wait_until_task_ref_names: Option<&[String]>, wait_for_seconds: Option<i32>, ) -> Result<WorkflowRun>
Update workflow state.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.
Sourcepub async fn execute_workflow_with_return_strategy(
&self,
request: &StartWorkflowRequest,
request_id: Option<&str>,
wait_until_task_ref: Option<&str>,
wait_for_seconds: i32,
consistency: Option<&str>,
return_strategy: Option<&str>,
) -> Result<SignalResponse>
pub async fn execute_workflow_with_return_strategy( &self, request: &StartWorkflowRequest, request_id: Option<&str>, wait_until_task_ref: Option<&str>, wait_for_seconds: i32, consistency: Option<&str>, return_strategy: Option<&str>, ) -> Result<SignalResponse>
Execute workflow with return strategy.
§Errors
Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.