Struct azure_functions_durable::Client

pub struct Client { /* fields omitted */ }

Represents the Durable Functions HTTP client.

Methods

impl Client

pub fn new(status_query_url: &str) -> Self

Creates a new client from the given status query URL.

pub fn task_hub(&self) -> &str

Gets the task hub associated with the client.

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.