Struct DurableOrchestrationClient

pub struct DurableOrchestrationClient { /* private fields */ }

Represents the Durable Functions orchestration client input binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
task_hub	The name of the task hub to use. Defaults to the value from host.json
connection	The name of an app setting that contains a storage account connection string. Defaults to the storage account for the function application.

Examples

Starting a new orchestration:

use azure_functions::{
    bindings::{DurableOrchestrationClient, HttpRequest, HttpResponse},
    func,
};
use serde_json::Value;

#[func]
pub async fn start(_req: HttpRequest, client: DurableOrchestrationClient) -> HttpResponse {
    match client
        .start_new(
            "orchestration",
            None,
            Value::Null,
        )
        .await
    {
        Ok(data) => data.into(),
        Err(e) => format!("Failed to start orchestration: {}", e).into(),
    }
}

Implementations

impl DurableOrchestrationClient

pub async fn instance_status( &self, instance_id: &str, show_history: bool, show_history_output: bool, show_input: bool, ) -> Result<OrchestrationStatus>

Gets the status of an orchestration instance.

pub async fn query_instances<I>( &self, created_time_from: Option<DateTime<Utc>>, created_time_to: Option<DateTime<Utc>>, runtime_statuses: Option<I>, top: Option<u32>, show_history: bool, show_history_output: bool, show_input: bool, ) -> Result<Vec<OrchestrationStatus>>

where I: Iterator<Item = OrchestrationRuntimeStatus>,

Queries the status for instances in a given date range or with runtime status.

pub async fn purge_history(&self, instance_id: &str) -> Result<()>

Purges the history of the given orchestration instance.

pub async fn purge_history_by_query<I>( &self, created_time_from: Option<DateTime<Utc>>, created_time_to: Option<DateTime<Utc>>, runtime_statuses: Option<I>, ) -> Result<u32>

where I: Iterator<Item = OrchestrationRuntimeStatus>,

Purges the history of orchestrations matching the given date range or runtime statuses.

pub async fn raise_event<D>( &self, instance_id: &str, event_name: &str, event_data: D, ) -> Result<()>

where D: Into<Value>,

Raises an event for the given orchestration instance.

pub async fn rewind(&self, instance_id: &str, reason: &str) -> Result<()>

Restores a failed orchestration instance into a running state by replaying the most recent failed operations.

pub async fn start_new<D>( &self, function_name: &str, instance_id: Option<&str>, input: D, ) -> Result<OrchestrationData>

where D: Into<Value>,

Starts a new orchestration by calling the given orchestration function.

pub async fn terminate(&self, instance_id: &str, reason: &str) -> Result<()>

Terminates a running orchestration instance.